Skip to content

Restructure documentation navigation (Phase 1)#551

Merged
danbarr merged 8 commits intomainfrom
docs-restructuring-phase1-preview
Feb 13, 2026
Merged

Restructure documentation navigation (Phase 1)#551
danbarr merged 8 commits intomainfrom
docs-restructuring-phase1-preview

Conversation

@danbarr
Copy link
Collaborator

@danbarr danbarr commented Feb 13, 2026

Description

Phase 1 of the documentation restructuring plan: sidebar navigation and information architecture changes. This PR reorganizes the sidebar to create clearer user journeys, self-contained product sections, and better progressive disclosure. No files are moved or renamed — this is purely a navigation/structure change.

Changes:

  • Drop "Guides:" prefix from all sidebar section labels (e.g., "Guides: CLI" → "CLI") for cleaner, scannable navigation
  • Move quickstarts into product sections as first items, so each section is self-contained (e.g., CLI Quickstart lives under CLI, not a separate Tutorials section)
  • Restructure CLI sidebar with an "Advanced workflows" category grouping telemetry, testing, build, and similar topics; rename "Permissions and security" for clarity
  • Reorder K8s sidebar to place authentication before telemetry (logical dependency order)
  • Reorder Registry Server sidebar with Introduction as first item, deployment before configuration
  • Replace Tutorials with Integrations section for cross-cutting guides (ngrok, Vault, OpenTelemetry, playground)
  • Create Reference section consolidating client compatibility, registry schemas, and CLI/CRD references
  • Add "Choose your path" cards to home page giving users a clear decision framework (Desktop app / CLI / Kubernetes) as the entry point

Type of change

  • Navigation/structure change

Submitter checklist

Content and formatting

  • I have reviewed the content for technical accuracy
  • I have reviewed the content for spelling, grammar, and style

Navigation

  • New pages include a frontmatter section with title and description at a minimum
  • Sidebar navigation (sidebars.ts) updated for added, deleted, reordered, or renamed files
  • Redirects added to vercel.json for moved, renamed, or deleted pages (i.e., if the URL slug changed)
    • N/A: No pages were moved, renamed, or deleted in this phase — all existing URLs remain stable

danbarr and others added 8 commits February 13, 2026 13:58
Rename all "Guides: X" sidebar labels to just "X" for cleaner
navigation. Also rename "Guides: MCP server usage" to
"MCP server guides".

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Each product section now has its quickstart as the first child item
(or after the intro page for sections that have one). The top-level
"Get started" category is removed. Quickstart sidebar labels
shortened to just "Quickstart" since the section provides context.

Also removes the now-broken quickstart-vmcp and link to the old
generated-index from the Tutorials category, since those items
have moved to their product sections.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Rename "Custom permissions" category to "Permissions and security".
Create new "Advanced workflows" category grouping auth, token
exchange, telemetry, test, build, CI/CD, custom registry, and API
server. These are multi-user or builder-focused topics that don't
belong in the core single-user workflow.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Move authentication and token exchange before telemetry and logging
in the Kubernetes Operator sidebar. Security is a core enterprise
concern that belongs earlier in the workflow.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add the intro page as the first explicit child item (labeled
"Introduction" in sidebar). Move deployment up to right after the
introduction -- the natural flow is understand → deploy → configure,
not configure → deploy.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the standalone Tutorials sidebar category with a new
Integrations section containing the cross-cutting integration guides
(OpenTelemetry, HashiCorp Vault, ngrok ingress). Update navbar
link accordingly.

Quickstarts already moved to product sections. Custom registry
already moved to CLI Advanced workflows. The tutorials/mcp-optimizer
file becomes unreferenced in the sidebar (the UI section already has
its own version; reframe to vMCP is a later phase).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Create a top-level Reference category containing client
compatibility (moved from its orphaned top-level position) and
registry schema references (previously not in any sidebar).

CLI command reference, CRD spec, API server reference, and Registry
API reference remain inline within their product sections.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Replace the single UI-only quickstart CTA with three cards routing
readers to the right quickstart based on their use case: Desktop
app for individual developers, CLI for power users, Kubernetes for
teams and enterprises.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings February 13, 2026 22:12
@vercel
Copy link

vercel bot commented Feb 13, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Feb 13, 2026 10:12pm

Request Review

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR implements Phase 1 of the documentation restructuring plan, reorganizing the sidebar navigation to create clearer user journeys and better progressive disclosure. The changes are purely structural—no files are moved or renamed, ensuring all existing URLs remain stable.

Changes:

  • Removed "Guides:" prefix from all sidebar section labels for cleaner navigation
  • Moved quickstart guides into their respective product sections as the first item to make each section self-contained
  • Restructured the CLI section with a new "Advanced workflows" category and renamed "Custom permissions" to "Permissions and security"
  • Created a new "Integrations" section (replacing "Tutorials") for cross-cutting integration guides with third-party tools
  • Added a new "Reference" section consolidating cross-cutting reference material, while keeping product-specific references within their sections
  • Added "Choose your path" decision cards to the homepage for better user onboarding

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
sidebars.ts Complete sidebar restructuring: removed "Guides:" prefixes, moved quickstarts into product sections, created Advanced workflows and Integrations sections, reorganized K8s and Registry Server item order, added Reference section
docusaurus.config.ts Updated footer navigation link from "Tutorials" to "Integrations"
docs/toolhive/index.mdx Added "Choose your path" cards with flexbox layout for Desktop app, CLI, and Kubernetes entry points
docs/toolhive/tutorials/quickstart-*.mdx Added sidebar_label: Quickstart to all quickstart files for consistent display when embedded in product sections
docs/toolhive/guides-registry/intro.mdx Added sidebar_label: Introduction for clearer navigation label

@danbarr danbarr enabled auto-merge (squash) February 13, 2026 22:36
@danbarr danbarr merged commit 8447e0f into main Feb 13, 2026
9 checks passed
@danbarr danbarr deleted the docs-restructuring-phase1-preview branch February 13, 2026 22:39
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