Apply SEO and metadata best practices#485
Open
mintlify[bot] wants to merge 3 commits into
Open
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
Tighten titles and descriptions on the v6 pages touched by hud-python#484 so each page has a specific, unique title under 60 characters and a description in the 130–155 character range.
Changes
docs/v6/guides/running-an-eval.mdx— replaced the generic "Evaluating Agents" title with one that names the workflow, and shortened the 172-char description to 133 chars.docs/v6/reference/cli.mdx— replaced the 3-char "CLI" title with a specific reference title; description reworded for uniqueness.docs/v6/reference/environment.mdx— replaced the generic "Environments" title with one that describes the object and serving API on this page.docs/v6/reference/runtime.mdx— replaced the generic "Runtimes" title with one naming the three runtime classes; shortened the 165-char description to 152 chars.docs/v6/start/overview.mdx— replaced the boilerplate "Overview" title with one that names the actual content (core concepts and workflow).Note
Low Risk
Documentation metadata only; no SDK, CLI, or runtime behavior changes.
Overview
Updates frontmatter only on ten v6 docs pages so each has a specific, unique
title(under ~60 characters) and adescriptionin the ~130–155 character band for search and social previews.Guides & start:
running-an-evalnames thehud evaltaskset workflow;overviewreplaces generic "Overview" with core concepts and the five-step eval workflow;quickstarttitles the five-minute first-task path.Reference:
cli,environment,runtime, andtrainingswap one-word or vague titles for titles that name what the page covers (CLI commands, Environment serving API, the three runtime classes, TrainingClient /hud models).More & advanced:
contributing,faq, androbotsget descriptive titles instead of "Contributing", "FAQ", and "Robots". Several pages also shorten or reword descriptions where they were too long or duplicated other pages.Reviewed by Cursor Bugbot for commit 751e0a5. Bugbot is set up for automated code reviews on this repo. Configure here.