Apply SEO and metadata best practices - #7206
Open
mintlify[bot] wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
Fixes SEO metadata across all locales: rewrites descriptions to the 130–160 character range, shortens over-long titles, and removes duplicate descriptions.
Changes
descriptionfields to unique, page-specific 130–155 character summaries in each page's language (en, es, fr, zh)titlefields that exceeded 60 charactersassistant/widget-previewlocale pages with unique per-language descriptionssidebarTitle, or page content modifiedContext
Full-repo audit of 1,053 MDX pages; validation and broken-link checks pass.
Note
Low Risk
Documentation frontmatter only; no runtime, auth, or build logic changes.
Overview
This PR updates frontmatter SEO metadata across English, Spanish, French, and Chinese docs—no page body, navigation, or OpenAPI spec changes.
Descriptions are rewritten to unique, page-specific summaries in each locale’s language, generally targeting the 130–160 character range. Short generic blurbs and overly long ones are replaced with copy that names Mintlify context (editor, assistant, analytics, etc.) where relevant. The four
assistant/widget-previewlocale pages no longer share the same English description.Titles are shortened on a handful of help-center articles (fork preview, private repo onboarding, static 404, rename deployment, and equivalents in
es/fr) so they stay within SEO-friendly length.OpenAPI operation pages that inherit summaries from specs are left unchanged.
Reviewed by Cursor Bugbot for commit 529da0b. Bugbot is set up for automated code reviews on this repo. Configure here.