Skip to content

Apply SEO and metadata best practices#485

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/83a8014e
Open

Apply SEO and metadata best practices#485
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/83a8014e

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

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 runtime, API, or page body changes.

Overview
Updates frontmatter only on five v6 docs pages so each has a specific, unique title (under ~60 characters) and a description in the ~130–155 character range for search and social previews.

running-an-eval, cli, environment, runtime, and overview swap generic titles like "Overview", "CLI", and "Environments" for titles that name the actual topic (e.g. evaluation workflow, CLI command reference, runtime class names). Descriptions are shortened or reworded to stay in range while still summarizing what each page covers.

Reviewed by Cursor Bugbot for commit 3c6bcdc. 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, 11:08 PM

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.

0 participants