Skip to content

Clarify ToolHive onboarding and navigation#800

Merged
danbarr merged 10 commits intomainfrom
toolhive-onboarding-cleanup-main
Apr 23, 2026
Merged

Clarify ToolHive onboarding and navigation#800
danbarr merged 10 commits intomainfrom
toolhive-onboarding-cleanup-main

Conversation

@danbarr
Copy link
Copy Markdown
Collaborator

@danbarr danbarr commented Apr 23, 2026

Description

This PR improves the first-hop ToolHive docs experience, mainly around /toolhive as the primary entry point for new readers.

The main goal is to make ToolHive read more clearly as a platform, not just a collection of components. The changes clarify how the UI, CLI, Kubernetes Operator, vMCP, Registry Server, and the built-in registry fit together, while keeping the existing product-area information architecture intact.

This PR also simplifies a few navigation and onboarding rough edges:

  • adds clearer sidebar grouping and reduces sidebar sprawl with auto-collapsing categories
  • tightens the landing-page intros so they lead with user value and platform role, especially for Registry Server
  • improves the main quickstarts so the path to first success is clearer and the page exits are more consistent
  • cleans up a few landing-page distractions on /toolhive, including redundant visuals and the inline repo laundry list

A few specific areas to review:

  • the new platform framing on /toolhive
  • the sidebar section headings and collapse behavior
  • the revised component intros for UI, CLI, Kubernetes Operator, vMCP, and Registry Server
  • the updated Registry Server positioning, which now emphasizes trusted catalogs, discoverability, publishing, governance, and skills support before standards/API compatibility

Type of change

  • Documentation update
  • Navigation/structure change

Related issues/PRs

  • N/A

Screenshots

  • Vercel preview can be used for sidebar and landing-page review
image

Submitter checklist

Content and formatting

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

Navigation

  • (N/A) 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)

Reviewer checklist

Content

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

Copilot AI review requested due to automatic review settings April 23, 2026 15:38
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 23, 2026

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

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Apr 23, 2026 9:14pm

Request Review

Copy link
Copy Markdown
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

Improves the ToolHive docs “first hop” experience by making /toolhive the clearer entry point, clarifying how ToolHive components relate (UI/CLI/Operator, vMCP, Registry Server, built-in registry), and adjusting navigation behavior/presentation to better match the new framing.

Changes:

  • Adds sidebar section headers and reorganizes the ToolHive sidebar to better reflect “run” vs “platform services” vs “shared guides” vs “reference/help”.
  • Updates /toolhive landing content and multiple guide intros/quickstarts to clarify platform components and onboarding flows.
  • Changes docs sidebar behavior to auto-collapse categories; removes the navbar “Integrations” entry.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/css/custom.css Adds styling for new non-clickable sidebar section headers.
sidebars.ts Inserts HTML-based section headers and refactors the reference/help grouping in the ToolHive sidebar.
docusaurus.config.ts Enables auto-collapsing doc categories; removes “Integrations” from the navbar dropdown.
docs/toolhive/index.mdx Adds a platform overview section and simplifies source/contribution links.
docs/toolhive/guides-vmcp/quickstart.mdx Clarifies prerequisites and next steps; adds related info and UI tip.
docs/toolhive/guides-vmcp/index.mdx Reframes vMCP intro in platform terms and adds local-eval guidance.
docs/toolhive/guides-ui/registry.mdx Renames the page title to “Use the registry”.
docs/toolhive/guides-ui/quickstart.mdx Clarifies “built-in registry” wording; adds related info section.
docs/toolhive/guides-ui/index.mdx Reframes UI as the fastest local start and positions it within the platform.
docs/toolhive/guides-registry/intro.mdx Expands intro to explain “why” and clarifies Registry Server vs built-in registry.
docs/toolhive/guides-registry/index.mdx Reframes Registry Server overview and clarifies when you do/don’t need it.
docs/toolhive/guides-k8s/quickstart.mdx Renames “What’s next?” to “Next steps” and adds related info links.
docs/toolhive/guides-k8s/index.mdx Reframes operator intro in platform terms (team/production-style deployments).
docs/toolhive/guides-cli/registry.mdx Renames the page title to “Use the registry”.
docs/toolhive/guides-cli/quickstart.mdx Makes client setup explicitly optional and reorders steps; adds related info.
docs/toolhive/guides-cli/index.mdx Reframes CLI positioning and adds a pointer to browsing the built-in registry.
Comments suppressed due to low confidence (1)

docs/toolhive/guides-cli/quickstart.mdx:242

  • Step 5 is explicitly optional, but Step 6 is written as the next required step and assumes the client is already configured via thv client setup. Consider making Step 6 optional as well (or gating it with “If you completed Step 5…”) and/or adding a short pointer to manual client configuration for readers who skip Step 5.
## Step 6: Use the MCP server with your AI client

Now that your MCP server is running, you can use it with your AI client
application. Open your supported client (VS Code, Cursor, etc.) and ask the AI
to fetch content from a website. Note that you might need to restart your client
for the changes to take effect.

Comment thread docs/toolhive/guides-registry/intro.mdx
@danbarr danbarr merged commit 9ab6247 into main Apr 23, 2026
3 checks passed
@danbarr danbarr deleted the toolhive-onboarding-cleanup-main branch April 23, 2026 22:10
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.

3 participants