Skip to content

Reorganize docs navigation into Guides, Reference, and SDK#229

Merged
clavery merged 2 commits intomainfrom
docs/reorganize-navigation
Mar 3, 2026
Merged

Reorganize docs navigation into Guides, Reference, and SDK#229
clavery merged 2 commits intomainfrom
docs/reorganize-navigation

Conversation

@clavery
Copy link
Collaborator

@clavery clavery commented Mar 3, 2026

Summary

  • Split the single 50+ item shared sidebar into purpose-driven L1 sections: Guides (conceptual/setup), Reference (CLI commands + MCP tools), and SDK (TypeDoc API)
  • Updated nav bar: Guides | MCP | Reference | SDK (was Guide | CLI Reference | API Reference | MCP Server) for jumping to the most likely landing points
  • Makes room for future VSCode section
  • Can move MCP above How-To if needed
  • Product-qualified ambiguous labels: "CLI Installation" vs "MCP Installation", "CLI Configuration" vs "MCP Configuration"
  • CLI commands alphabetically sorted in the Reference sidebar
  • Renamed "API Reference" → "SDK" / "SDK Reference" throughout (nav, sidebar, home page, TypeDoc source)
  • /mcp/* routes show the Guides sidebar; /mcp/tools/* routes show the Reference sidebar (VitePress longest-prefix matching)

Split the single 50+ item shared sidebar into purpose-driven sidebars:
- Guides sidebar: Getting Started, How-To, MCP Server, Extending
- Reference sidebar: CLI Commands (alphabetized) + MCP Tools
- SDK sidebar: renamed from "API Reference"

Product-qualify ambiguous labels (CLI Installation vs MCP Installation)
and update nav bar (Guides | MCP | Reference | SDK).
Copy link
Contributor

@patricksullivansf patricksullivansf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks less crowded. I like it

@clavery clavery merged commit b893aa8 into main Mar 3, 2026
5 of 6 checks passed
@clavery clavery deleted the docs/reorganize-navigation branch March 3, 2026 18:07
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