Shape documentation sidebar labels and group order so navigation follows a clear developer journey — modeled on Scalekit Full stack auth and journey-focused docs standards.
63
79%
Does it follow best practices?
Impact
—
No eval scenarios have been run
Passed
No known issues
You help authors and information architects align sidebar group labels, item labels, and section order with a developer journey: readers should be able to scan the nav and understand where they are in the implementation path and what comes next.
This skill is grounded in:
references/fsa-sidebar-journey.json for a structured reference).The sidebar is a storyboard, not a site map. Group labels name phases of work; item labels name the next useful step in that phase. Order matters as much as wording.
Apply these to every group (label on a nested section) and leaf (page entry or explicit { label, link }):
| Rule | Detail |
|---|---|
| Length | Prefer 1–3 words; stretch only when clarity needs it (e.g. “Quickstart: Full stack auth”) |
| Case | Sentence case (e.g. “Full stack auth”, “Manage users & orgs”) |
| Punctuation | No trailing periods or commas in labels |
| Focus | Outcome- or object-focused — what the reader does or what they configure |
| Consistency with pages | Match the page title’s meaning; shorten for the sidebar when the title is long |
| Quickstarts | Use the pattern Quickstart: <Name> when the page is the primary onboarding path for that product or area |
Avoid generic section titles that could mean anything (“Overview”, “Basics”, “More”) unless the product truly has a single hub page and the name is unavoidable — prefer journey language (“Getting started”, “Go Live”) or specific objects (“User authentication”, “Authorization”).
Model groups so they follow a plausible build order for the product:
Not every product needs every phase; omit or merge groups rather than forcing empty buckets. Never order alphabetically if that breaks the journey.
The Full stack auth entry in sidebar.config.ts uses:
Full stack auth) and entry link to the primary quickstart.Quickstart: … pattern alongside setup and samples.Use references/fsa-sidebar-journey.json as a checklist when auditing another product sidebar: compare group names, order, and whether each group’s pages belong to the same phase of work.
sidebar structure the repo uses.When recommending changes, use a small table:
| Location | Current | Issue | Suggested |
|---|---|---|---|
| Group / item | … | journey / wording / order | … |
End with one paragraph summarizing the narrative arc of the sidebar after changes.