Skip to content

Improve SEO metadata across documentation#5647

Open
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-audit-1777691191
Open

Improve SEO metadata across documentation#5647
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-audit-1777691191

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 2, 2026

Summary

Audited all MDX files for SEO and metadata quality. Targeted issues per the success criteria: unique titles under 60 characters and unique descriptions between 130–160 characters (except OpenAPI operation pages where the spec supplies the description).

Changes

Removed description: frontmatter from 20 OpenAPI operation pages. Each operation has a description defined in the OpenAPI spec, so the page-level description was overriding the spec metadata. Removing them lets the spec descriptions render as intended.

  • api/agent/* (3 v1 + 3 v2 endpoints)
  • api/analytics/* (7 endpoints)
  • api/assistant/* (4 endpoints)
  • api/preview/trigger.mdx
  • api/update/{status,trigger}.mdx

Lengthened 15 short descriptions that fell under the 130-character minimum, adding specific search-friendly terms while keeping each unique:

  • agent/index.mdx
  • components/cards.mdx
  • editor-classic.mdx
  • editor/{collaborate,configurations,index,live-preview,navigation,pages,share-a-preview,tutorial}.mdx
  • workflows/{create,enable,index,manage}.mdx

Shortened 1 too-long description under the 160-character limit:

  • optimize/search-boost.mdx

Replaced one generic title. Changed workflows/index.mdx title from Overview to Workflows overview (with sidebarTitle: "Overview" preserved) so the page title describes the specific content rather than relying on a generic pattern.

Notes

  • No content was changed — only frontmatter.
  • No OpenAPI spec files were modified.
  • Validation: no broken internal links. Pre-existing docs.json schema validation errors are unrelated to these changes.

Note

Low Risk
Low risk because this PR only updates MDX frontmatter (titles/descriptions) and removes page-level description fields to let OpenAPI specs drive operation metadata; no runtime or API behavior changes.

Overview
SEO/metadata cleanup across docs. Updates a set of MDX frontmatter description values (mostly lengthening for specificity, shortening one) and refines wording for agent/editor/workflows/component pages.

For OpenAPI-backed API reference pages, removes frontmatter description on several v1/v2 endpoints so the OpenAPI operation descriptions are no longer overridden, and renames workflows/index.mdx title to Workflows overview while keeping sidebarTitle: "Overview".

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

Generated-By: mintlify-agent
@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 2, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 2, 2026, 3:12 AM

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