Skip to content

Apply SEO and metadata best practices#474

Merged
jdchawla29 merged 1 commit into
mainfrom
mintlify/d8c9d63a
Jun 25, 2026
Merged

Apply SEO and metadata best practices#474
jdchawla29 merged 1 commit into
mainfrom
mintlify/d8c9d63a

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Expanded short frontmatter descriptions on v6 guide, reference, and start pages so they fall within the 130–160 character SEO target.

Changes

  • Rewrote descriptions on guides/creating-an-environment, guides/running-an-eval, start/overview, and the reference/ pages (capabilities, cli, environment, runtime, tasks, training) with page-specific, searchable terms.
  • All titles in scope already fit under 60 characters and are descriptive; no title changes needed.
  • No duplicate descriptions among pages in scope.

Note

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

Overview
Updates only the YAML description field in frontmatter on nine v6 docs pages—no body copy, titles, or other metadata.

Each description is rewritten to be page-specific and keyword-rich (HUD, env.py, taskset, CLI, etc.) and sized for the usual ~130–160 character meta-description range. Pages touched: guides (creating-an-environment, running-an-eval), start (overview), and reference (capabilities, cli, environment, runtime, tasks, training).

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

@mintlify

mintlify Bot commented Jun 25, 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 Jun 25, 2026, 4:43 AM

@jdchawla29 jdchawla29 merged commit 4089df0 into main Jun 25, 2026
10 checks passed
@mintlify

mintlify Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor Author

Docs PR opened: #476

Replaced the generic "Overview" title on the v6 start overview page with a descriptive title covering HUD core concepts and workflow.

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