Add cross-references to Registry Server from existing docs#706
Merged
Add cross-references to Registry Server from existing docs#706
Conversation
Add inbound links to the Registry Server documentation from five existing pages so users discover it at relevant points in their journey. Adds tip admonitions to the UI and CLI registry guides, a disambiguation note to registry criteria, a paragraph and bullet to the custom registry tutorial, and a mention in the K8s operator introduction. Closes #366 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds inbound documentation cross-references so users configuring registries (or running ToolHive on Kubernetes) can discover the ToolHive Registry Server at the right decision points, and clarifies “built-in registry” vs “Registry Server” terminology.
Changes:
- Adds
:::tip[Host your own registry]admonitions to the UI and CLI registry guides linking to the Registry Server docs. - Adds a
:::note[Built-in registry vs. Registry Server]disambiguation to the registry criteria concept doc. - Updates the custom registry tutorial and the Kubernetes Operator intro to mention the Registry Server as a complementary/production option.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| docs/toolhive/tutorials/custom-registry.mdx | Adds Registry Server cross-reference in “Why…” and “Production considerations”. |
| docs/toolhive/guides-ui/registry.mdx | Adds a tip pointing UI users to Registry Server for hosting remote registries. |
| docs/toolhive/guides-k8s/index.mdx | Mentions Registry Server deployment/discovery via MCPRegistry resources. |
| docs/toolhive/guides-cli/registry.mdx | Adds a tip pointing CLI users to Registry Server for hosting remote registries. |
| docs/toolhive/concepts/registry-criteria.mdx | Adds a note clarifying built-in registry vs. Registry Server docs. |
Reword the Registry Server paragraph in the K8s operator intro to make it clear that MCPRegistry is a separate capability, not a 4th MCP server resource type. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.
Summary
Closes #366
:::tip[Host your own registry]admonitions to the UI and CLI registry guides, pointing users to the Registry Server when configuring remote registries:::note[Built-in registry vs. Registry Server]disambiguation to the registry criteria pageSkipped the main
index.mdxinsertion points from the issue because they already have prominent Registry Server cross-references (lines 125-131 in "ToolHive components").Test plan
🤖 Generated with Claude Code