docs: deduplicate generic page titles for SEO#5840
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
1 participant
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
Replace generic, duplicated page titles with descriptive ones so each page has a unique title for search snippets, while keeping the short labels in the sidebar via
sidebarTitle.Changes
index.mdx:Introduction→Mintlify documentation(sidebar keepsIntroduction)api/introduction.mdx:Introduction→Mintlify REST API introduction(sidebar keepsIntroduction)api-playground/overview.mdx:Playground→Interactive API playground(sidebar keepsPlayground)api-playground/websocket-playground.mdx:Playground→WebSocket API playground(sidebar keepsPlayground)components/index.mdx:Overview→Components overview(sidebar keepsOverview)deploy/docs-subpath.mdx:Overview→Host docs on a /docs subpath(sidebar keepsOverview)Context
Audited all English MDX frontmatter for title/description quality (length, uniqueness, generic patterns). All English pages have well-formed descriptions in the 130–160 character range and titles under 60 characters. The only remaining issues were six pages that shared three duplicated, generic single-word titles. OpenAPI operation-reference pages were left as-is since their descriptions come from the spec. Localized (
es/,fr/,zh/) andsnippets/files were not modified.Note
Low Risk
Low risk documentation-only change that updates frontmatter
titlevalues for SEO; no runtime behavior or API surface changes.Overview
Updates six MDX pages to replace duplicated, generic frontmatter
titlevalues (e.g., “Introduction”, “Overview”, “Playground”) with more descriptive, unique titles for better SEO/search snippets, while keeping navigation labels unchanged viasidebarTitle.Reviewed by Cursor Bugbot for commit f1c2d89. Bugbot is set up for automated code reviews on this repo. Configure here.