Apply SEO and metadata best practices#474
Merged
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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. |
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
Expanded short frontmatter descriptions on v6 guide, reference, and start pages so they fall within the 130–160 character SEO target.
Changes
guides/creating-an-environment,guides/running-an-eval,start/overview, and thereference/pages (capabilities,cli,environment,runtime,tasks,training) with page-specific, searchable terms.Note
Low Risk
Documentation metadata only; no runtime, API, or application code changes.
Overview
Updates only the YAML
descriptionfield 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.