Skip to content

docs: improve SEO titles and descriptions across docs#73

Open
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/3a28412f
Open

docs: improve SEO titles and descriptions across docs#73
mintlify[bot] wants to merge 1 commit into
mainfrom
mintlify/3a28412f

Conversation

@mintlify
Copy link
Copy Markdown

@mintlify mintlify Bot commented May 27, 2026

Summary

Audit and improve title/description frontmatter across English MDX pages so each page has a unique, descriptive title under 60 characters and a unique description between 130–160 characters.

Changes

  • Disambiguated duplicate titles (Overview, Authentication, Client Libraries, Introduction, Rate Limiting, Idempotency, Quick Start) so each title describes the specific page (e.g., Account overview, Admin API authentication, Webhooks quick start).
  • Rewrote short descriptions (under 130 characters) on account/*, features/*, platform/*, getting-started/*, guides/*, webhooks/*, and admin-api/api-reference top-level pages so each one summarizes the page in 130–155 characters and includes searchable terms.
  • Resolved the duplicate descriptions previously shared between admin-api/ and api-reference/ (authentication, client-libraries, rate-limiting).
  • Added a missing description to uikit/overview.mdx.
  • Normalized guide titles to sentence case.

Context

OpenAPI operation pages (under */endpoints/** and webhooks/events/**) were left untouched: all operations in openapi/admin.yml and openapi/application.yml already supply a description, so adding frontmatter would override the spec-provided metadata. Spanish (es/) pages were not edited — they are regenerated from the English source by the Lingo translation workflow on main.

@mintlify
Copy link
Copy Markdown
Author

mintlify Bot commented May 27, 2026

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

Project Status Preview Updated (UTC)
trophy 🟢 Ready View Preview May 27, 2026, 12:56 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