Apply SEO and metadata best practices#6718
Merged
Merged
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. |
ethanpalm
reviewed
Jul 24, 2026
ethanpalm
approved these changes
Jul 24, 2026
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
2 participants
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
Tightened title and description on the SDK reference setup page so it meets SEO length/specificity targets.
Changes
api-playground/sdk-reference-setup.mdx: rewrote title to describe what the page actually does (was slightly generic at 19 chars) and expanded the description from 121 to 147 chars so it sits in the 130–160 range Google prefers, while retaining the doc-tool keywords (TypeDoc, DocFX, Javadoc, Sphinx, phpDocumentor).Note
Low Risk
Documentation metadata only; no runtime, API, or content body changes.
Overview
Updates only the frontmatter on
api-playground/sdk-reference-setup.mdxfor SEO and nav clarity.The title is now action-oriented (“Generate SDK reference pages from doc-tool output”) instead of the shorter generic “SDK reference setup.” A
sidebarTitleof “SDK reference setup” keeps the sidebar label unchanged. The description is expanded to spell out publishing from TypeDoc, DocFX, Javadoc, Sphinx, or phpDocumentor via thesdknavigation property, targeting the preferred ~130–160 character range. Page body and keywords are unchanged.Reviewed by Cursor Bugbot for commit 1a1f1f3. Bugbot is set up for automated code reviews on this repo. Configure here.