Improve SEO metadata across documentation pages#5449
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Improve SEO metadata across documentation pages#5449mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
… page descriptions Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
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
Audited all MDX files for SEO and metadata quality. Two categories of issues were found and fixed:
Short descriptions lengthened (6 pages)
Descriptions under 130 characters were expanded to the 130–160 character target range:
agent/linear.mdx(119 → 148 chars)assistant/configure.mdx(127 → 148 chars)assistant/customize.mdx(110 → 147 chars)components/cards.mdx(128 → 148 chars)components/visibility.mdx(128 → 131 chars)enterprise-contracting.mdx(69 → 155 chars)Redundant API descriptions removed (19 pages)
All API reference pages with OpenAPI operation references had manually written
descriptionfields that duplicated information already provided by the OpenAPI spec. Removed these so metadata comes from the spec as the single source of truth.Audit results (no action needed)
Note
Low Risk
Documentation-only metadata edits with no runtime or API behavior changes; low risk aside from potential SEO/metadata regressions if OpenAPI descriptions are incomplete.
Overview
Improves SEO/frontmatter metadata across docs by expanding several short
descriptionfields (e.g., Linear agent, assistant settings/customization, cards, visibility, enterprise contracting) to be more specific and keyword-rich.Removes redundant
descriptionfrontmatter from multiple API reference MDX pages that already declareopenapioperations, so descriptions come from the OpenAPI spec as the single source of truth.Reviewed by Cursor Bugbot for commit a38e26c. Bugbot is set up for automated code reviews on this repo. Configure here.