Skip to content

docs: improve SEO titles and descriptions for SDK reference pages - #219

Merged
mintlify[bot] merged 1 commit into
mainfrom
mintlify/dc980af3
May 18, 2026
Merged

docs: improve SEO titles and descriptions for SDK reference pages#219
mintlify[bot] merged 1 commit into
mainfrom
mintlify/dc980af3

Conversation

@mintlify

@mintlifymintlifyBot commented May 18, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds descriptive, search-friendly titles and unique descriptions to the 46 TypeDoc-generated SDK reference pages, which previously had boilerplate titles (e.g. Class: AuthenticationError) and no description frontmatter at all.

Changes

  • Replaced boilerplate Class: X / Interface: X / Type Alias: X / client/x titles with specific, descriptive titles under 60 characters.
  • Added a unique description (130–160 chars) to every SDK reference page so each page has a distinct, search-relevant snippet instead of a Google-generated one.
  • Covers all of docs/sdk/reference/**: module index pages, error classes, interceptors, managers, transport, model interfaces, and option type aliases.
  • No page content was changed — only frontmatter.

Context

Audit of all 183 MDX files found that the rest of the docs already have well-formed title and description frontmatter; the only SEO gaps were in the generated SDK reference subtree.

@mintlify

mintlifyBot commented May 18, 2026

Copy link
Copy Markdown
ContributorAuthor

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

ProjectStatusPreviewUpdated (UTC)
terminal49🟢 ReadyView PreviewMay 18, 2026, 12:14 AM

@greptile-apps

Copy link
Copy Markdown

Target branch is in the excluded branches list.

@vercel

vercelBot commented May 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

ProjectDeploymentActionsUpdated (UTC)
apiBuildingBuildingPreview, CommentMay 18, 2026 0:14am

Request Review

@mintlify
mintlifyBot merged commit aad3536 into mainMay 18, 2026
8 of 10 checks passed
Sign up for freeto 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