docs: improve SEO titles and descriptions across docs#128
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
|
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
Audits all MDX pages for SEO metadata quality and fills in missing or fixes weak
titleanddescriptionfrontmatter on 783 pages so each page has a unique, descriptive entry under standard SEO length guidelines.Changes
descriptionfrontmatter on pages that were missing one, too short (<130 chars), too long (>160 chars), or duplicated across pages — descriptions now target 130–160 chars and summarize the specific page content.x-api/(Standard X API v2) andenterprise-api/(Enterprise X API v2) sections by appending a tier label so each page has a unique snippet.titlefrontmatter on a small number of pages whose OpenAPI operation references do not supply a specsummary(e.g.create-replay-job,get-marketplace-handle-availability,get-ai-trends-by-id,community-notes/introduction).enterprise-api/tools-and-libraries.mdxandx-api/migrate/ready-to-migrate.mdxwith minimaltitle+descriptionfrontmatter.openapi:operation supplies adescriptionin the spec.Context
Pages with
openapi:operation references inheritsummaryanddescriptionfromopenapi.json; those were left to use the spec metadata. Audit after the change reports 0 missing/short/long/duplicate descriptions across all non-translation, non-snippet MDX files.