docs: SEO metadata audit

[mintlify]

Audit the documentation files in scope for this run for SEO and metadata quality. Check for:

• Missing or empty title frontmatter
• Titles that are too long (over 60 characters) — long titles are truncated in search result snippets
• Titles that follow a boilerplate pattern like "PageType - Name" without describing the specific content of the page
• Missing or empty description frontmatter (see OpenAPI pages below — do not treat as missing when an OpenAPI spec supplies the description)
• Descriptions that are too short (under 130 characters) — short descriptions are frequently ignored by Google in favor of auto-generated snippets
• Descriptions that are too long (over 160 characters)
• Pages in scope that share an identical description — each page needs a unique, page-specific description (uniqueness can only be checked among the pages in scope, not against the whole repo)

When writing titles: be descriptive and specific about what the page covers. Avoid generic patterns like "Overview - Product Name". Target 50-60 characters.

When writing descriptions: summarize what the specific page covers in plain language. Include 2-3 terms a user would actually search for. Never reuse the same description across pages. Target 130-155 characters.

Pages with openapi: in frontmatter (API reference from spec)

The openapi: frontmatter value can be either an operation reference (e.g., openapi: GET /users/{id}) or a file reference (e.g., openapi: ./openapi.yaml). Only operation references supply per-page summary and description from the spec.

For pages with an operation reference:

• Read the referenced OpenAPI spec file to check whether the operation defines a description.
• If the operation has a description: do not add a description: field to frontmatter. If one was incorrectly added, remove it so the metadata comes from the spec.
• If the operation has no description: audit description frontmatter as normal — add one if missing or fix it if it fails the quality checks.
• If the operation defines a summary and the page has no title: frontmatter, treat the title as present — do not add one.
• Never edit the OpenAPI spec files themselves.

For pages with a file reference, audit all frontmatter fields as normal.

Only update title and description frontmatter. Do not modify sidebarTitle — it is a navigation label and has no SEO impact. Do not change page content or OpenAPI spec files.

Only review the documentation files listed under "Changed files" for this run. If no such list is provided, review all MDX files in the docs.

Open a pull request with improvements for any issues found.

Success criteria:

• Pages have a unique title under 60 characters that describes the specific content
• Pages have a unique description between 130 and 160 characters (except for pages where the OpenAPI spec supplies the description)

If all pages have complete and reasonable metadata, do nothing.

---

Note

Low Risk
Documentation-only frontmatter changes with no application code, auth, or deployment logic affected.

Overview
This PR audits SEO frontmatter across a large set of Mintlify docs (EN, ES, FR, ZH, and related locales). It tightens title and description for search snippets without changing page body content or sidebarTitle.

English and localized hubs get more specific titles (for example generic labels like "Introduction", "Navigation", or "Files" become phrases such as "Mintlify documentation platform", "Documentation navigation", and "Static files"). Several dashboard, deploy, editor, and customize pages follow the same pattern.

Mintlify Index API reference pages (api/search-index/contents, context, search) drop redundant description fields so metadata comes from the OpenAPI operation spec, per the audit rules.

Chinese (zh/) pages receive the bulk of edits: expanded description text aimed at the 130–160 character SEO band, plus clearer title strings on many section overviews (agent, API playground, components, deploy, editor, and more). A few EN API/analytics zh pages get fuller, page-specific descriptions.

search-index/mcp.mdx slightly extends its description; optimize/analytics and similar pages rename titles for clarity (e.g. "Analytics" → "Documentation analytics").

^{Reviewed by Cursor Bugbot for commit 2d7e739. Bugbot is set up for automated code reviews on this repo. Configure here.}

[mintlify-development]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
userauth	🟢 Ready	View Preview	Aug 6, 2026, 6:54 AM

[mintlify-development]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
prosignuptest	🟢 Ready	View Preview	Aug 6, 2026, 7:02 AM

[mintlify-development]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
mintlify	🟢 Ready	View Preview	Aug 6, 2026, 6:57 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

[mintlify-development]

Preview deployment for your docs. Learn more about Mintlify Previews.

Project	Status	Preview	Updated (UTC)
testing	🟢 Ready	View Preview	Aug 6, 2026, 7:13 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

[cursor]

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 2d7e739. Configure here.}

[cursor]

Wrong editor configurations SEO metadata

Medium Severity

The new title and updated description say this page covers editor page metadata settings, but the page content is about the site Configurations panel for branding, appearance, and features. That violates the audit rule that titles and descriptions must describe the specific page content, and it misleads search snippets relative to the English page.

 

^{Reviewed by Cursor Bugbot for commit 2d7e739. Configure here.}

[ethanpalm]

too large to review and too many changes that would need to be edited out like adding a lot of "Documentation platform" and other extraneous words to titles