Repository navigation
feat(portal): Page layouts and nav reorg - #7548
cloudjumpercat wants to merge 5 commits into
Conversation
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
|
✅ KSAI Review: Finished Run report (federated) · 1 paid run · $0.2093 total
Reviewing cost $0.2093 |
There was a problem hiding this comment.
| Check | Result |
|---|---|
| Scope | Dev Portal documentation only: a sidebar navigation bullet and a new Page layouts section. |
| Mandate | default-code-review |
| Findings | 1 Medium, 1 Low |
| Findings audit | Independent audit completed: both findings verified in the tree; the endpoint wording corrected, severities unchanged. |
The change documents Dev Portal page layouts and sidebar navigation. One documented customization path is absent from the repository's Portal Management spec, and the layout list repeats one link three times.
| * `reference`: Contains [sidebar navigation](/dev-portal/customizations/dev-portal-customizations/#dev-portal-navigation) and content. Use this for shorter conceptual pages. | ||
| * `wide`: Contains [sidebar navigation](/dev-portal/customizations/dev-portal-customizations/#dev-portal-navigation) and content, but the contents space has a wider column. Use this for content that needs more horizontal room, like a wide table or a generated API reference. |
There was a problem hiding this comment.
🔵 Low nit
The guide bullet above already links the sidebar navigation section. The reference and wide bullets repeat that link and its wording. Keep the link once.
| * `reference`: Contains [sidebar navigation](/dev-portal/customizations/dev-portal-customizations/#dev-portal-navigation) and content. Use this for shorter conceptual pages. | |
| * `wide`: Contains [sidebar navigation](/dev-portal/customizations/dev-portal-customizations/#dev-portal-navigation) and content, but the contents space has a wider column. Use this for content that needs more horizontal room, like a wide table or a generated API reference. | |
| * `reference`: Contains sidebar navigation and content. Use this for shorter conceptual pages. | |
| * `wide`: Contains sidebar navigation and content, but the contents space has a wider column. Use this for content that needs more horizontal room, like a wide table or a generated API reference. |
React 👍 if this finding helped, 👎 if it did not.
There was a problem hiding this comment.
I believe this should be updated to include the new one as well?
| * **Footer bottom menu**: Footer bottom menu is a flat list of links that will be added to the bottom of every page. Footer bottom menus are placed below footer menu sections. | ||
| * **Sidebar navigation**: The sidebar navigation menu is a vertical list of links that displays on the left side of the page. | ||
| You can configure this in the **Sidebar Navigation** section of the Portal Editor or using the [`/portals/{portalId}/customization/navigations` endpoint](/api/konnect/portal-management/). | ||
| Whether a sidebar menu is displayed depends on the [page layout](/dev-portal/pages-and-content/#page-layouts). |
There was a problem hiding this comment.
This sentence is very important and IMO should stand out more; without it, the UI doesn't render. Can we call this out better?
|
|
||
| The following layouts are available: | ||
|
|
||
| * `custom` (default): No built-in chrome. You build the whole page yourself, including sidebars and header. Use this for a landing page or anything the other layouts don't fit. Because `custom` doesn't render a title or description from front matter, give the page its own heading in the body. |
There was a problem hiding this comment.
suggestion: since we want customers to utilize the other layouts by default, can we move custom to the end of the list?
|
|
||
| Any section a layout renders (a sidebar or the header) can be replaced with a snippet using the `layout-options` front matter property. | ||
|
|
||
| For information about how to customize a layout's sidebars and header, or configure page navigation, see the [Markdown Components reference](https://portaldocs.konghq.com/). |
There was a problem hiding this comment.
Links you may use (currently unpublished):
- Pages (including front matter):
https://portaldocs.konghq.com/pages/overview - Layout options:
- Layouts:
https://portaldocs.konghq.com/pages/layouts - Layout options:
https://portaldocs.konghq.com/pages/layout-options
Co-authored-by: Adam DeHaven <2229946+adamdehaven@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
tomek-labuk
left a comment
There was a problem hiding this comment.
To me, this feels like content for a reference page rather than a landing page. Adding screenshots in a column next to the text breaks the layout and makes larger chunks text hardly readable
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Description
Fixes #7066 #7391
Preview Links
Broken links are expected since the MDC docs aren't live yet.
Checklist
descriptionentry in frontmatter.