Improve SEO frontmatter across docs#5645
Open
mintlify[bot] wants to merge 2 commits intomainfrom
Open
Conversation
Generated-By: mintlify-agent
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 every English MDX page for SEO and metadata quality and fixed all issues found.
Changes
descriptionfields from 20 API reference pages. Each of these pages uses an OpenAPI operation reference (e.g.openapi: /analytics.openapi.json GET /v1/analytics/{projectId}/views) and the linked operation already defines adescriptionin the spec. Per Mintlify behavior, the spec description is used when no frontmatterdescriptionis set, so the duplicate has been removed to keep the spec as the single source of truth.optimize/search-boost.mdx(was 167 chars; now 147).Audit results
After the changes, every English page either has a unique 130–160 character description or correctly delegates to its OpenAPI spec. No titles exceeded 60 characters before or after.
The 7 files in
snippets/without frontmatter are import-only partials (e.g.,Counter,IconsOptional) — not standalone pages — so SEO frontmatter does not apply.Files touched
api/agent/**,api/analytics/**,api/assistant/**,api/preview/trigger.mdx,api/update/**agent/index.mdx,components/cards.mdx,editor-classic.mdx,editor/**,optimize/search-boost.mdx,workflows/**No page content or OpenAPI spec files were modified — frontmatter only.
Note
Low Risk
Low risk: documentation-only frontmatter edits (mostly
description), with no changes to page content or API behavior. Main risk is minor SEO/snippet regressions if any description copy is inaccurate.Overview
SEO-focused frontmatter cleanup across docs pages. Updates and expands
descriptiontext on multiple narrative pages (agent, editor, workflows, components, optimization) to be more specific and search-friendly.API reference pages now defer descriptions to OpenAPI. Removes redundant frontmatter
descriptionfields from various OpenAPI-backed API docs (agent, analytics, assistant, preview, deploy/update) so the spec remains the single source of truth.Reviewed by Cursor Bugbot for commit de9b5a1. Bugbot is set up for automated code reviews on this repo. Configure here.