Skip to content

docs: improve page titles for SEO uniqueness#5852

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/9dd78efa
Open

docs: improve page titles for SEO uniqueness#5852
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/9dd78efa

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 18, 2026

Summary

Resolves duplicate page titles across the English docs so each page has a unique, descriptive title for search snippets.

Changes

  • api/introduction.mdx: "Introduction" → "Mintlify REST API introduction"
  • api-playground/overview.mdx: "Playground" → "API playground overview"
  • api-playground/websocket-playground.mdx: "Playground" → "WebSocket playground"
  • components/index.mdx: "Overview" → "MDX components overview"
  • deploy/docs-subpath.mdx: "Overview" → "Host docs at a subpath"

Context

Audit findings for English MDX pages:

  • All English page titles were under 60 characters and all descriptions fell within 130–160 characters
  • No duplicate descriptions
  • Three pairs of pages shared generic titles ("Introduction", "Playground", "Overview") — fixed here
  • Pages with OpenAPI operation references already inherit description from the spec, so no frontmatter changes were needed there
  • Localized pages (es/, fr/, zh/) are managed by the translation tooling (gt.config.json) and were intentionally not edited

Note

Low Risk
Low risk: documentation-only frontmatter title updates with no functional or behavioral changes.

Overview
Updates frontmatter title values across several English MDX pages to replace generic/duplicate titles (e.g., "Overview", "Playground", "Introduction") with unique, descriptive titles for better SEO and clearer search snippets.

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

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 18, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 18, 2026, 7:16 PM

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 18, 2026

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

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview May 18, 2026, 7:15 PM

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

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.

1 participant