Skip to content

Apply SEO and metadata best practices#483

Closed
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/e90a33fb
Closed

Apply SEO and metadata best practices#483
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/e90a33fb

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrote generic one- or two-word page titles across the docs so each page has a descriptive, search-friendly title in the 34–56 character range.

Changes

  • Replaced boilerplate titles like Overview, FAQ, CLI, Types, Graders, Runtimes, Training, Agents, Capabilities, Environments, Introduction, Quickstart, Contributing, Changelog, Protocol, Robots, A2A chat, Coding agent, Ops diagnostics, Robot benchmark, Extending HUD, Harbor interop, Designing tasks, Migrate to v6, and Tasks & Tasksets with titles that identify the specific product area and content.
  • Normalized headings to sentence case (e.g. Creating EnvironmentsCreating HUD environments with tasks and capabilities, Evaluating AgentsEvaluating agents on HUD tasksets and runtimes).
  • Left description frontmatter unchanged — every page already had a unique description between 132–155 characters.
  • Did not modify sidebarTitle, page content, or any OpenAPI specs.

Note

Low Risk
Documentation metadata only; no runtime, API, or application code changes.

Overview
Updates only the title field in MDX frontmatter across the docs site—roughly 30 pages spanning changelog, start guides, how-tos, reference, advanced topics, cookbooks, and more.

Short labels like Overview, CLI, FAQ, and Quickstart are replaced with descriptive, keyword-rich titles (for example HUD quickstart: your first task, agent, and reward and Capabilities reference: HUD environment wire protocols). Guide pages that used title-case product phrasing are aligned to sentence-style titles that name the HUD area and what the page covers.

Unchanged: description frontmatter, page body, navigation/sidebarTitle (where present), and OpenAPI specs. This is a metadata/SEO pass, not a content rewrite.

Reviewed by Cursor Bugbot for commit 5027d01. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
hud 🟢 Ready View Preview Jul 8, 2026, 1:56 AM

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.

1 participant