Docs: take sidebar group order from frontmatter, not a hardcoded list - #5513
Merged
Conversation
The docs sidebar ranked its group headings with a GROUP_ORDER array in useDocsNav.ts, so adding, renaming or reordering a group meant a change here even though the docs themselves live in FlowFuse/flowfuse and already declare the group names in navGroup. A group now takes the lowest navGroupOrder declared by its sections, so the whole docs structure is owned by the docs repo. Groups nobody ranks fall to the end, sorted by name. The builder moves to nuxt/lib/docs-nav.mjs as plain JS, matching docs-sync.mjs, so `npm test` can cover it; the composable keeps the types and stays the import surface for DocsLeftNav. Verified against the real docs tree: identical nav to the GROUP_ORDER implementation for all 115 pages.
Contributor
Author
|
Needs a review after FlowFuse/flowfuse#8069 merges and here the preview gets rebuilt |
dimitrieh
marked this pull request as draft
August 5, 2026 10:17
Contributor
Author
|
Waiting on this one to be merged first |
✅ Deploy Preview for flowforge-website ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Author
Contributor
Author
|
dimitrieh
marked this pull request as ready for review
August 5, 2026 11:23
Contributor
Author
|
@Yndira-E this is about moving logic of how the left hand navigation for docs is defined from the website to the documentation so there is an SSOT. With the docs to nuxt migration this got tangled up, and currently part of the nav is hardcoded in https://github.com/FlowFuse/website. FlowFuse/flowfuse#8069 is merged, now we can look at this do this one :) |
Contributor
Author
|
This is in preparation of structural documentation changes coming up which then only need to hit one repository. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The docs sidebar ranked its group headings with a
GROUP_ORDERarray innuxt/composables/useDocsNav.ts, so adding, renaming or reordering a group meant a change here even though the docs live in FlowFuse/flowfuse and already declare the group names innavGroup.A group now takes the lowest
navGroupOrderdeclared by its sections, so the docs repo owns the whole structure. Groups nobody ranks fall to the end, sorted by name. The builder moves tonuxt/lib/docs-nav.mjsas plain JS (same reason asdocs-sync.mjs) sonpm testcovers it; the composable keeps the types and stays the import surface forDocsLeftNav.Depends on FlowFuse/flowfuse#8069, which adds the frontmatter. Merge that first: until it lands, docs are cloned from flowfuse
mainwith nonavGroupOrder, and the preview here shows the groups alphabetically.Verified against the real docs tree with the flowfuse branch synced: identical nav to the
GROUP_ORDERimplementation across all 115 docs pages.Related Issue(s)
None.
Checklist