Apply SEO and metadata best practices#483
Closed
mintlify[bot] wants to merge 1 commit into
Closed
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
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
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, andTasks & Tasksetswith titles that identify the specific product area and content.Creating Environments→Creating HUD environments with tasks and capabilities,Evaluating Agents→Evaluating agents on HUD tasksets and runtimes).descriptionfrontmatter unchanged — every page already had a unique description between 132–155 characters.sidebarTitle, page content, or any OpenAPI specs.Note
Low Risk
Documentation metadata only; no runtime, API, or application code changes.
Overview
Updates only the
titlefield 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, andQuickstartare replaced with descriptive, keyword-rich titles (for exampleHUD quickstart: your first task, agent, and rewardandCapabilities 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:
descriptionfrontmatter, 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.