Docs cleanup: acme.com, stale notes, filler descriptions - #1078
Merged
Conversation
acme.com is a real, registered domain. example.com is reserved by IANA (RFC 2606) so it never resolves, making it the correct choice for documentation examples. Fixes #1070
The note described one-time migration behavior for users upgrading across the v0.1.0 boundary, which shipped over a year and 40 releases ago. The remaining guidance is already covered by the surrounding page content. Fixes #1071
The admonition mostly duplicated the behavior table directly above it, and the old behavior it described was a bug (silently broken DNS for host-networked workloads), so the audience relying on previous behavior is near zero. Also reword body prose that leaked version framing into a plain statement of current behavior. Fixes #1072
The front matter descriptions started with 'Learn how to' or 'A guide to,' crowding out the useful summary in the first ~70 characters used for the DocCard preview. Lead with the action or topic instead. Fixes #1073
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Documentation cleanup pass across ToolHive CLI, integrations, and Enterprise Manager policy docs to remove stale/version-framed guidance and to make examples/descriptions safer and more scannable (especially in DocCard previews).
Changes:
- Replaced
acme.comwith RFC 2606example.comURLs in registry and telemetry policy examples. - Removed stale/duplicative version-callout content in CLI guides (auto-discovery removal note; v0.40.0 network isolation admonition).
- Rewrote three integrations front matter descriptions to drop filler openers and lead with the action/topic.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/toolhive/integrations/vault.mdx | Front matter description rewritten to remove “Learn how to” filler and front-load the summary. |
| docs/toolhive/integrations/ingress-ngrok.mdx | Front matter description rewritten to remove “A guide to” filler and improve DocCard preview usefulness. |
| docs/toolhive/integrations/aws-sts.mdx | Front matter description rewritten to remove “Learn how to” filler and lead with the action. |
| docs/toolhive/guides-cli/network-isolation.mdx | Removed version-framing sentence and trimmed redundant “Changed in v0.40.0” admonition that duplicated the behavior table. |
| docs/toolhive/guides-cli/client-configuration.mdx | Removed stale note about auto-discovery removal in v0.1.0. |
| docs/platform/enterprise-manager/policies/telemetry.mdx | Updated example OTLP endpoints from *.acme.com to *.example.com. |
| docs/platform/enterprise-manager/policies/registry.mdx | Updated example registry endpoints from *.acme.com to *.example.com. |
JAORMX
approved these changes
Jul 30, 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
Small documentation cleanup pass addressing four issues found during review:
acme.com(a real, registered domain) withexample.com(IANA-reserved, RFC 2606) in registry and telemetry policy examples.:::info[Changed in v0.40.0]admonition in the network isolation guide that duplicated the behavior table above it, and reworded a sentence that leaked version framing into body prose.Each fix is its own commit for easy review.
Type of change
Related issues/PRs
Fixes #1070
Fixes #1071
Fixes #1072
Fixes #1073
Screenshots
N/A
Submitter checklist
Content and formatting
Reviewer checklist
Content