docs: improve SEO titles and descriptions for SDK reference pages#219
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Target branch is in the excluded branches list. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 nodescriptionfrontmatter at all.Changes
Class: X/Interface: X/Type Alias: X/client/xtitles with specific, descriptive titles under 60 characters.description(130–160 chars) to every SDK reference page so each page has a distinct, search-relevant snippet instead of a Google-generated one.docs/sdk/reference/**: module index pages, error classes, interceptors, managers, transport, model interfaces, and option type aliases.Context
Audit of all 183 MDX files found that the rest of the docs already have well-formed
titleanddescriptionfrontmatter; the only SEO gaps were in the generated SDK reference subtree.