Improve SEO metadata across documentation#5647
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
Generated-By: mintlify-agent
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
Audited all MDX files for SEO and metadata quality. Targeted issues per the success criteria: unique titles under 60 characters and unique descriptions between 130–160 characters (except OpenAPI operation pages where the spec supplies the description).
Changes
Removed
description:frontmatter from 20 OpenAPI operation pages. Each operation has adescriptiondefined in the OpenAPI spec, so the page-level description was overriding the spec metadata. Removing them lets the spec descriptions render as intended.api/agent/*(3 v1 + 3 v2 endpoints)api/analytics/*(7 endpoints)api/assistant/*(4 endpoints)api/preview/trigger.mdxapi/update/{status,trigger}.mdxLengthened 15 short descriptions that fell under the 130-character minimum, adding specific search-friendly terms while keeping each unique:
agent/index.mdxcomponents/cards.mdxeditor-classic.mdxeditor/{collaborate,configurations,index,live-preview,navigation,pages,share-a-preview,tutorial}.mdxworkflows/{create,enable,index,manage}.mdxShortened 1 too-long description under the 160-character limit:
optimize/search-boost.mdxReplaced one generic title. Changed
workflows/index.mdxtitle fromOverviewtoWorkflows overview(withsidebarTitle: "Overview"preserved) so the page title describes the specific content rather than relying on a generic pattern.Notes
docs.jsonschema validation errors are unrelated to these changes.Note
Low Risk
Low risk because this PR only updates MDX frontmatter (titles/descriptions) and removes page-level
descriptionfields to let OpenAPI specs drive operation metadata; no runtime or API behavior changes.Overview
SEO/metadata cleanup across docs. Updates a set of MDX frontmatter
descriptionvalues (mostly lengthening for specificity, shortening one) and refines wording for agent/editor/workflows/component pages.For OpenAPI-backed API reference pages, removes frontmatter
descriptionon several v1/v2 endpoints so the OpenAPI operation descriptions are no longer overridden, and renamesworkflows/index.mdxtitle toWorkflows overviewwhile keepingsidebarTitle: "Overview".Reviewed by Cursor Bugbot for commit 64e09b6. Bugbot is set up for automated code reviews on this repo. Configure here.