Skip to content

Improve SEO frontmatter across docs#5645

Open
mintlify[bot] wants to merge 2 commits intomainfrom
mintlify/seo-metadata-1777689189
Open

Improve SEO frontmatter across docs#5645
mintlify[bot] wants to merge 2 commits intomainfrom
mintlify/seo-metadata-1777689189

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 2, 2026

Summary

Audited every English MDX page for SEO and metadata quality and fixed all issues found.

Changes

  • Removed redundant description fields 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 a description in the spec. Per Mintlify behavior, the spec description is used when no frontmatter description is set, so the duplicate has been removed to keep the spec as the single source of truth.
  • Expanded 15 descriptions that were under the 130-character SEO threshold. Each new description is unique, in the 130–155 character range, and includes search terms a user would actually type (e.g. live cursors, drag-and-drop, automerge, cron, docs.json, MDX).
  • Trimmed one over-long description on 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.

Issue Before After
Description too short (<130) 35 0
Description too long (>160) 1 0
Description that should be removed (op has spec desc) 20 0
Duplicate descriptions 0 0

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

  • 20 API reference pages (description removed): api/agent/**, api/analytics/**, api/assistant/**, api/preview/trigger.mdx, api/update/**
  • 16 narrative pages (description rewritten): 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 description text 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 description fields 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.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented May 2, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview May 2, 2026, 2:45 AM

@mintlify-development
Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
userauth 🟡 Building May 2, 2026, 2:43 AM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants