Add guided entry, disambiguation, and consistent structure to section index pages#637
Merged
Add guided entry, disambiguation, and consistent structure to section index pages#637
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
danbarr
changed the title
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation-focused PR to standardize and improve the “intro” and “index” (landing) pages across ToolHive docs sections, helping readers quickly choose an entry path based on their goals and current setup.
Changes:
- Added/updated “Where to start” sections across multiple guides (UI, CLI, Kubernetes Operator, vMCP, Registry Server).
- Clarified Registry Server vs ToolHive built-in registry with consistent callouts and links.
- Added cross-links to the Okta end-to-end RBAC example from auth/authorization concept and guide pages.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/toolhive/guides-vmcp/intro.mdx | Normalizes related-link capitalization for consistency. |
| docs/toolhive/guides-vmcp/index.mdx | Rewrites landing copy and adds “Where to start” navigation. |
| docs/toolhive/guides-ui/index.mdx | Adds “Where to start” section to guide new vs returning users. |
| docs/toolhive/guides-registry/intro.mdx | Adds callout clarifying Registry Server vs built-in registry with pointers to CLI/UI. |
| docs/toolhive/guides-registry/index.mdx | Adds the same clarification plus “Where to start” navigation for Registry Server. |
| docs/toolhive/guides-k8s/intro.mdx | Adds a resource-type decision guide to help users pick MCPServer vs MCPRemoteProxy vs VirtualMCPServer. |
| docs/toolhive/guides-k8s/index.mdx | Updates intro and adds “Where to start” + links into the new decision guide. |
| docs/toolhive/guides-k8s/auth-k8s.mdx | Adds link to Okta RBAC walkthrough as a complete end-to-end example. |
| docs/toolhive/guides-cli/index.mdx | Adds “Where to start” section for CLI users. |
| docs/toolhive/concepts/cedar-policies.mdx | Adds link to Okta RBAC walkthrough as a practical example. |
| docs/toolhive/concepts/auth-framework.mdx | Adds link to Okta RBAC walkthrough as a complete end-to-end example. |
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Standardize capitalization of "ToolHive Kubernetes Operator" and "ToolHive Registry Server" as product names throughout the docs. Consolidate intro page titles from "Overview" to "Introduction" and rename redundant "Overview" H2s. Shorten duplicate registry disambiguation admonition on index page. Fix import placement, first-person voice, and other minor issues. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
rdimitrov
approved these changes
Mar 27, 2026
This was referenced Mar 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Improve section intro/index pages and make them more consistent across the site.
First batch of updates for phase 3 of the docs restructuring / user journey fixup plan.
Type of change
Submitter checklist
Content and formatting
Reviewer checklist
Content