Skip to content

Add next steps and cross-links across all doc sections#638

Merged
danbarr merged 2 commits intomainfrom
phase-3-next-steps-and-links
Mar 27, 2026
Merged

Add next steps and cross-links across all doc sections#638
danbarr merged 2 commits intomainfrom
phase-3-next-steps-and-links

Conversation

@danbarr
Copy link
Copy Markdown
Collaborator

@danbarr danbarr commented Mar 27, 2026

Description

Phase 3 of the docs restructuring: adds "Next steps" sections and cross-section navigation links across all five documentation sections (CLI, UI, K8s, vMCP, Registry Server) plus the vMCP concepts page.

This addresses the top remaining issue from the user journey analysis: dead-end pages with no forward navigation. Previously, vMCP had zero pages with "Next steps", and many pages across all sections relied entirely on sidebar navigation.

What changed (36+ files):

  • Added "Next steps" sections to every guide page that was missing one
  • Connected auth and telemetry to the main workflow paths (previously buried/isolated)
  • Added cross-section bridge links (K8s → vMCP, K8s → Registry Server, permissions → auth)
  • Made undiscoverable pages reachable (API server, playground, operational pages)
  • Rewrote Registry Server "Next steps" from grab-bag lists to sequential guidance
  • Normalized em dashes to hyphens in list descriptions for consistency
  • Fixed quickstart gap in vMCP concepts page

Type of change

  • Navigation/structure change

Related issues/PRs

Continues the work from #637.

Submitter checklist

Content and formatting

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

🤖 Generated with Claude Code

danbarr and others added 2 commits March 27, 2026 10:52
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
- Add "Next steps" to 13 pages that were missing them across CLI,
  K8s, vMCP, Registry, and UI sections
- Replace em dashes and en dashes with hyphens in list items
- Add cross-section links from CLI and vMCP terminal pages to
  K8s, vMCP, and Registry sections
- Fix backward-pointing next steps (CLI auth → run-mcp-servers)
- Restore skills link dropped from Registry intro and telemetry
- Clean up hedging language in Registry deployment next steps

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 27, 2026 15:23
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 27, 2026

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

Project Deployment Actions Updated (UTC)
docs-website Ready Ready Preview, Comment Mar 27, 2026 3:24pm

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

Phase 3 of the ToolHive docs restructuring to reduce “dead-end” pages by adding consistent forward navigation (“Next steps”) and improving cross-links across the major documentation sections (CLI, UI, K8s, vMCP, Registry Server) plus the vMCP concepts page.

Changes:

  • Added/updated “Next steps” sections across many guides to provide clearer onward navigation paths.
  • Refined “Related information” lists and cross-section bridge links (for example, K8s → vMCP, vMCP → Registry).
  • Added a Husky pre-commit hook to run lint-staged.

Reviewed changes

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

Show a summary per file
File Description
docs/toolhive/tutorials/mcp-optimizer.mdx Minor link-list formatting consistency update.
docs/toolhive/guides-vmcp/tool-aggregation.mdx Adds “Next steps” and trims “Related information” accordingly.
docs/toolhive/guides-vmcp/telemetry-and-metrics.mdx Adds “Next steps” and normalizes related links.
docs/toolhive/guides-vmcp/scaling-and-performance.mdx Adds “Next steps” with cross-links to K8s/Registry guidance.
docs/toolhive/guides-vmcp/optimizer.mdx Adds “Next steps” and normalizes related link formatting.
docs/toolhive/guides-vmcp/intro.mdx Adds “Next steps” and simplifies “Related information”.
docs/toolhive/guides-vmcp/failure-handling.mdx Adds “Next steps” and normalizes related link descriptions.
docs/toolhive/guides-vmcp/configuration.mdx Reworks “Next steps” to a clearer sequential flow.
docs/toolhive/guides-vmcp/composite-tools.mdx Adds “Next steps” for follow-on operational topics.
docs/toolhive/guides-vmcp/backend-discovery.mdx Adds “Next steps” and removes duplicate related link.
docs/toolhive/guides-vmcp/authentication.mdx Adds “Next steps” and expands related links to Cedar policies.
docs/toolhive/guides-vmcp/audit-logging.mdx Adds “Next steps” and normalizes related link descriptions.
docs/toolhive/guides-ui/secrets-management.mdx Adds “Next steps” to guide users into security + client setup.
docs/toolhive/guides-ui/network-isolation.mdx Adds “Next steps” linking into tool customization and client config.
docs/toolhive/guides-ui/mcp-optimizer.mdx Adds “Next steps” and improves related links for context/background.
docs/toolhive/guides-ui/group-management.mdx Adds “Next steps” to connect groups → secrets/tools/client config.
docs/toolhive/guides-ui/customize-tools.mdx Adds “Next steps” to push users toward testing + client setup.
docs/toolhive/guides-ui/client-configuration.mdx Adds “Next steps” for testing + tool customization.
docs/toolhive/guides-ui/cli-access.mdx Adds “Next steps” to bridge UI workflows into CLI docs.
docs/toolhive/guides-registry/telemetry-metrics.mdx Updates “Next steps” to a more guided sequence.
docs/toolhive/guides-registry/skills.mdx Renames “What’s next” → “Next steps” and adds related info section.
docs/toolhive/guides-registry/intro.mdx Updates “Next steps” to emphasize auth and configuration flow.
docs/toolhive/guides-registry/deployment.mdx Adds “Next steps” for post-deploy configuration/auth/telemetry.
docs/toolhive/guides-registry/deploy-manual.mdx Adds “Next steps” consistent with other deployment paths.
docs/toolhive/guides-registry/database.mdx Updates “Next steps” to emphasize telemetry + deployment.
docs/toolhive/guides-registry/configuration.mdx Rewrites “Next steps” into a tighter auth/db follow-up path.
docs/toolhive/guides-registry/authentication.mdx Updates “Next steps” to point to db + telemetry.
docs/toolhive/guides-k8s/token-exchange-k8s.mdx Adds “Next steps” to connect token exchange → telemetry/logging.
docs/toolhive/guides-k8s/telemetry-and-metrics.mdx Adds “Next steps” and normalizes related info descriptions.
docs/toolhive/guides-k8s/run-mcp-k8s.mdx Replaces paragraph “Next steps” with scannable bullet navigation and cross-links.
docs/toolhive/guides-k8s/redis-session-storage.mdx Adds “Next steps” to connect sessions → token exchange/telemetry.
docs/toolhive/guides-k8s/deploy-operator.mdx Updates “Next steps” into concise bullets and adds auth follow-up.
docs/toolhive/guides-k8s/customize-tools.mdx Adds “Next steps” to connect customization → auth/telemetry.
docs/toolhive/guides-k8s/auth-k8s.mdx Normalizes dash usage and adds “Next steps”.
docs/toolhive/guides-cli/token-exchange.mdx Adds “Next steps” to connect token exchange → telemetry/testing.
docs/toolhive/guides-cli/thvignore.mdx Adds “Next steps” linking into network isolation.
docs/toolhive/guides-cli/test-mcp-servers.mdx Adds “Next steps” for packaging/CI/CD/security follow-ups.
docs/toolhive/guides-cli/telemetry-and-metrics.mdx Adds “Next steps” to connect telemetry → lifecycle management/tutorials.
docs/toolhive/guides-cli/secrets-management.mdx Adds “Next steps” and corrects an internal relative link.
docs/toolhive/guides-cli/run-mcp-servers.mdx Expands “Next steps” into actionable bullets including auth/telemetry/API server.
docs/toolhive/guides-cli/network-isolation.mdx Adds “Next steps” linking into auth.
docs/toolhive/guides-cli/manage-mcp-servers.mdx Adds “Next steps” and removes a redundant related link.
docs/toolhive/guides-cli/group-management.mdx Adds “Next steps” and removes a redundant related link.
docs/toolhive/guides-cli/filesystem-access.mdx Adds “Next steps” linking into .thvignore and network isolation.
docs/toolhive/guides-cli/custom-permissions.mdx Adds “Next steps” linking into auth.
docs/toolhive/guides-cli/client-configuration.mdx Adds “Next steps” linking into permissions + auth.
docs/toolhive/guides-cli/auth.mdx Adds “Next steps” and rewrites related info into clearer bullets.
docs/toolhive/guides-cli/api-server.mdx Adds “Next steps” linking into auth + telemetry.
docs/toolhive/guides-cli/advanced-cicd.mdx Adds “Next steps” and trims redundant related link.
docs/toolhive/faq.mdx Normalizes dash usage in lists for consistency.
docs/toolhive/concepts/vmcp.mdx Adds “Next steps” and removes redundant related link.
.husky/pre-commit Adds a pre-commit hook intended to run lint-staged.

@danbarr danbarr marked this pull request as ready for review March 27, 2026 16:01
@danbarr danbarr merged commit d1b227a into main Mar 27, 2026
8 checks passed
@danbarr danbarr deleted the phase-3-next-steps-and-links branch March 27, 2026 16:03
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