Skip to content

Sidebar Strategy

The sidebar should be easy to edit by hand and predictable for the team.

  • Keep one sidebar definition file or one manifest that generates it.
  • Group pages by section, not by feature sprint.
  • Use index.md as the first item in each section.
  • Keep section ordering stable.
  • Put templates outside the main navigation groups.

In this template

The shared section manifest lives in docs/.vitepress/content.ts and drives both navigation and sidebar output.

When to update the sidebar

  • New live docs page is added.
  • A section grows large enough to need another subgroup.
  • A page moves to a different section.

What to avoid

  • Deep nesting.
  • Duplicate links.
  • Auto-generation that hides the structure from maintainers.

Markdown-first documentation for teams that update docs often.