Skip to content

docs: declare sidebar group order in section frontmatter - #8069

Merged
dimitrieh merged 2 commits into
mainfrom
docs-nav-group-order
Aug 5, 2026
Merged

docs: declare sidebar group order in section frontmatter#8069
dimitrieh merged 2 commits into
mainfrom
docs-nav-group-order

Conversation

@dimitrieh

@dimitrieh dimitrieh commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

The docs sidebar groups sections under a navGroup heading, but the order of those headings is a hardcoded array in the website repo (GROUP_ORDER in nuxt/composables/useDocsNav.ts), even though the group names themselves are declared here. Adding, renaming or reordering a group needed a website change.

This adds navGroupOrder alongside each navGroup. The website ranks a heading by the lowest navGroupOrder of its sections, so the whole docs structure (paths, page order, group names, group order) now lives in this repo.

Values reproduce the order the site renders today. Merge this before the website side, which drops the array: FlowFuse/website#5513

The docs sidebar groups sections under a `navGroup` heading, but the
order of those groups was a hardcoded array in the website repo, so
reordering, renaming or adding a group meant a website change even
though the group names themselves are declared here.

Add `navGroupOrder` alongside each `navGroup`. The website derives a
group's position from the lowest `navGroupOrder` of its sections, so
the whole docs structure (paths, page order, group names, group order)
now lives with the docs.

Values match the order the website rendered before this change.
@dimitrieh

Copy link
Copy Markdown
Contributor Author

@hardillb this is about moving logic of how the navigation 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.

After this PR merges, we can merge FlowFuse/website#5513

@dimitrieh
dimitrieh merged commit 60b2078 into main Aug 5, 2026
15 checks passed
@dimitrieh
dimitrieh deleted the docs-nav-group-order branch August 5, 2026 11:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants