Repository navigation
fix(docs): keep the component pages in name order in the navigation - #56
Merged
alexgrozav merged 1 commit intoOct 22, 2026
Merged
Conversation
Nuxt Content orders the docs by file path, so once a component page is split into a folder, like `checkbox/`, it comes after a page whose name starts with the folder's, like `checkbox-group.md`, since `-` sorts before `/`. The sidebar, the header's menu and the links to the previous and next pages would then list the Checkbox Group before the Checkbox. `sortNavigation()` in `app/lib/navigation.ts` orders the component pages by their navigation title, and leaves the numbered sections as they are. DocsNavigation.vue, which renders the sidebar and the menu, reads it, and UContentSurround.vue replaces Nuxt UI's links to the previous and next pages, which Docus fills in Nuxt Content's order, with the pages before and after in the same order. Co-authored-by: multica-agent <github@multica.ai>
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://keep-component-order-uxf-424-opencomponents.blue-water-0397.workers.dev (commit bc2b726)This URL reflects your latest Preview deploymentPreview Deployments by commit
|
4 tasks done
alexgrozav
added a commit
that referenced
this pull request
Oct 23, 2026
… layer (#69) ## What changed The other ten component pages now have the shape the Button's got in #54: the Card, Checkbox, Checkbox Group, Dialog, Input, Radio Group, Spinner, Switch, Textarea and Tooltip each become a folder in `content/docs/3.components/`. Each folder holds an Overview and a page per layer: User Interface (UI), User Experience (UX), Developer Experience (DX) and Agentic Experience (AX). The text moves as it is. The only changes are the ones the Button's split made: the cards in place of the intro's list of layers, At a glance starting before the paragraph on examples, the four Checklist links, each part's rules under "UI Checklist" and so on, its questions under its own FAQ, and link targets. Once the Checkbox was a folder, Nuxt Content would have listed Checkbox Group before it, since it sorts by file path and `-` comes before `/`. `app/lib/navigation.ts` keeps the component pages in name order in the sidebar, the header's menu and the links to the previous and next pages. `app/components/UContentSurround.vue` replaces Nuxt UI's to read that order. The tests that covered the Button's split, and the Button-only checks in `scripts/check-mcp.mjs`, now run once for every split component. Links between components go straight to the section's new page. Links from before the split, like `/docs/components/input#sizes`, still land on the right page through the redirect map. In the sidebar and the header's menu, a component's name opens and closes the list of its pages, the Overview and its layers, without navigating, so you pick the page you want. The group still opens on any of its pages and closes once you leave them. Agents see no difference. `/raw/docs/components/<component>.md` and `.yaml`, and the MCP server, serve each component as one page with the outline and contract it has on `main`. The FAQ comes back grouped by layer. A changelog entry announces the change, and `AGENTS.md` and `.github/CONTRIBUTING.md` now say every component page is split like the Button's. It collects these PRs, each reviewed on its own: #56 (component order), #57 (split tests), #58 to #67 (one per component), #68 (links between components, changelog, guides) and #70 (the name opens the group, without navigating). To try it, run `pnpm dev` and open `/docs/components/checkbox`. ## Checklist - [x] The title follows [Conventional Commits](https://www.conventionalcommits.org), as in `feat(docs): add the focus guideline`. - [x] `pnpm check-types` passes. - [x] Docs changes: the pages read well on `pnpm dev`. (Checked on a `pnpm build` served with `wrangler dev`.) - [x] Homepage changes: `pnpm build`, then `pnpm lighthouse`, still scores 100 in every category. (No homepage changes, but the redirect map now covers eleven components and loads on every page, so it ran: 100 in every category on all three runs.) --------- Co-authored-by: multica-agent <github@multica.ai>
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
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.
What changed
Nuxt Content orders the docs by file path. Once a component page is split into a folder, like
checkbox/, it comes after a page whose name starts with the folder's, likecheckbox-group.md, since-sorts before/. The sidebar, the header's menu and the links to the previous and next pages would then list the Checkbox Group before the Checkbox. Onmainthe order is still right, since no page that's a prefix of another is split yet.sortNavigation()inapp/lib/navigation.tsorders the component pages by their navigation title, and leaves the numbered sections, and the parts of a split page, in Nuxt Content's order.DocsNavigation.vue, which renders the sidebar and the menu, reads it. Docus fills the previous and next links from Nuxt Content's own order, soapp/components/UContentSurround.vuereplaces Nuxt UI's links with one that finds the pages before and after in the same sorted tree, with their descriptions, and renders Nuxt UI's component with them. It's listed under "Replaced theme components" inAGENTS.md. The tests are inapp/lib/navigation.test.ts, whichvitest.config.tsnow includes.There are no content changes. With a scratch
checkbox/folder in place ofcheckbox.md, the sidebar, the 375px menu and the previous and next links all go Card, Checkbox, Checkbox Group, Dialog, where the base build lists the Checkbox Group first.Checklist
feat(docs): add the focus guideline.pnpm check-typespasses.pnpm dev. (Checked on awrangler devbuild of the site, with a scratch split Checkbox.)pnpm build, thenpnpm lighthouse, still scores 100 in every category. (No homepage changes. It passes the0.95budget.)