Improve frontmatter descriptions for SEO and DocCards#674
Merged
Conversation
Rewrite descriptions across 40 doc pages to front-load key information within the ~70 character DocCard truncation point while expanding total length to the 80-150 character range for better search engine results. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Document the dual-purpose nature of frontmatter descriptions (DocCard preview and SEO meta) with concrete guidance on front-loading, length targets, and common anti-patterns to avoid. 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
Updates the documentation frontmatter description fields to improve DocCard previews and SEO meta descriptions, and adds shared guidance so future pages follow the same pattern.
Changes:
- Rewrites many
descriptionfrontmatter values to front-load key info for DocCards while keeping SEO-friendly lengths. - Adds description-writing guidance (including YAML safety notes) to
STYLE-GUIDE.mdandAGENTS.md. - Adds “Front Matter Descriptions” review criteria to the docs-review skill.
Reviewed changes
Copilot reviewed 43 out of 43 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| STYLE-GUIDE.md | Adds detailed guidance + examples for writing DocCard/SEO-friendly descriptions and YAML safety notes. |
| AGENTS.md | Adds concise description-field requirements to page requirements. |
| .claude/skills/docs-review/SKILL.md | Adds explicit review checklist items for frontmatter descriptions (length, filler openers, YAML safety). |
| docs/toolhive/index.mdx | Updates intro page description for clearer DocCard + SEO summary. |
| docs/toolhive/support.mdx | Refines support page description to be more specific and front-loaded. |
| docs/toolhive/faq.mdx | Expands FAQ description to include key topics for better previews/search. |
| docs/toolhive/enterprise.mdx | Updates enterprise offering description to be more explicit about governance/compliance/security. |
| docs/toolhive/contributing.mdx | Updates contributing description to emphasize contribution modes and ecosystem scope. |
| docs/toolhive/tutorials/custom-registry.mdx | Rewrites description to focus on curated team/org registries. |
| docs/toolhive/reference/api.mdx | Rewrites API reference description to enumerate key endpoint themes. |
| docs/toolhive/reference/registry-api.mdx | Updates registry server API description for clearer scope. |
| docs/toolhive/reference/registry-schema-upstream.mdx | Updates upstream schema page description to be more specific and keyword-rich. |
| docs/toolhive/reference/registry-schema-toolhive.mdx | Updates ToolHive schema page description to mention metadata/config fields. |
| docs/toolhive/reference/client-compatibility.mdx | Rewrites description to enumerate compatibility dimensions (transport/auth/features). |
| docs/toolhive/integrations/opentelemetry.mdx | Refines description to front-load telemetry value and mention supported tools/deploy modes. |
| docs/toolhive/guides-ui/install.mdx | Updates UI install guide description to include OSes and purpose. |
| docs/toolhive/guides-ui/quickstart.mdx | Tightens quickstart description to a concise, action-led summary. |
| docs/toolhive/guides-ui/run-mcp-servers.mdx | Updates description to clarify sources (registry/custom images) and UI context. |
| docs/toolhive/guides-ui/registry.mdx | Updates description to emphasize search/install workflow in the desktop app. |
| docs/toolhive/guides-ui/client-configuration.mdx | Updates description to name common clients and desktop app context. |
| docs/toolhive/guides-cli/install.mdx | Updates CLI install description to include platforms and lifecycle actions. |
| docs/toolhive/guides-cli/quickstart.mdx | Tightens quickstart description to a concise, action-led summary. |
| docs/toolhive/guides-cli/run-mcp-servers.mdx | Updates description to include key mechanisms (shortcuts/images/env vars). |
| docs/toolhive/guides-cli/test-mcp-servers.mdx | Updates description to include pre-production validation framing. |
| docs/toolhive/guides-cli/registry.mdx | Updates description to emphasize search/inspect/run workflow via CLI. |
| docs/toolhive/guides-cli/client-configuration.mdx | Updates description to name common clients and ToolHive MCP connection scope. |
| docs/toolhive/guides-cli/api-server.mdx | Updates description to clarify local REST automation use case. |
| docs/toolhive/guides-k8s/quickstart.mdx | Updates operator quickstart description to front-load deployment + first server goal. |
| docs/toolhive/guides-k8s/run-mcp-k8s.mdx | Updates description to mention MCPServer CRDs and configuration focus. |
| docs/toolhive/guides-k8s/connect-clients.mdx | Updates description to clarify client-to-Kubernetes-hosted servers connection. |
| docs/toolhive/guides-k8s/logging.mdx | Updates description to specify log levels/formats/output for operator + servers. |
| docs/toolhive/guides-k8s/telemetry-and-metrics.mdx | Updates description to front-load enabling OpenTelemetry/Prometheus in K8s. |
| docs/toolhive/guides-vmcp/intro.mdx | Updates description to explain aggregation benefit for client config. |
| docs/toolhive/guides-vmcp/quickstart.mdx | Tightens description to focus on aggregation outcome and vMCP. |
| docs/toolhive/concepts/vmcp.mdx | Updates concept description to concise value statement aligned with vMCP intro. |
| docs/toolhive/concepts/groups.mdx | Updates groups concept description to concise function + access control scope. |
| docs/toolhive/concepts/skills.mdx | Updates skills concept description to define skills and key components. |
| docs/toolhive/concepts/tool-optimization.mdx | Updates description to focus on context reduction + tool selection accuracy. |
| docs/toolhive/concepts/observability.mdx | Updates description to enumerate metrics/traces/logging. |
| docs/toolhive/concepts/mcp-primer.mdx | Updates primer description to define MCP clearly and concretely. |
| docs/toolhive/concepts/registry-criteria.mdx | Updates description to emphasize requirements + review criteria. |
| docs/toolhive/concepts/backend-auth.mdx | Updates description to remove filler opener and list key auth patterns. |
| docs/toolhive/concepts/auth-framework.mdx | Updates description to concise summary of the authz/authn framework purpose. |
rdimitrov
approved these changes
Apr 7, 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
Rewrites frontmatter
descriptionfields across 40 documentation pages to optimize for both DocCard display and search engine meta descriptions.Description updates:
Writing guidelines:
Type of change
Related issues/PRs
Submitter checklist
Content and formatting
🤖 Generated with Claude Code