Skip to content

Improve SEO frontmatter (titles and descriptions) across docs#5649

Merged
mintlify[bot] merged 1 commit intomainfrom
mintlify/seo-metadata-audit-1777691514
May 2, 2026
Merged

Improve SEO frontmatter (titles and descriptions) across docs#5649
mintlify[bot] merged 1 commit intomainfrom
mintlify/seo-metadata-audit-1777691514

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented May 2, 2026

Summary

Audited every MDX page (excluding snippets and translated files) for SEO and metadata quality, and fixed the issues found.

  • 35 short descriptions (under 130 characters) and 1 overly long description (167 characters) on non-API pages were rewritten to land in the 130–160 character range while staying specific and unique.
  • 20 API reference pages with OpenAPI operation references had a description: field in frontmatter that overrode the per-operation description from the OpenAPI spec. Removed those fields so the metadata comes from the spec.

No titles were missing, too long, boilerplate, or duplicated, and no descriptions were duplicated across pages.

Affected pages

Non-API pages (description rewritten)

  • agent/index.mdx
  • components/cards.mdx
  • editor-classic.mdx
  • editor/index.mdx, editor/collaborate.mdx, editor/configurations.mdx, editor/live-preview.mdx, editor/navigation.mdx, editor/pages.mdx, editor/share-a-preview.mdx, editor/tutorial.mdx
  • optimize/search-boost.mdx
  • workflows/index.mdx, workflows/create.mdx, workflows/enable.mdx, workflows/manage.mdx

API pages (frontmatter description: removed; spec supplies it)

  • api/agent/create-agent-job.mdx, get-agent-job.mdx, get-all-jobs.mdx
  • api/agent/v2/create-agent-job.mdx, get-agent-job.mdx, send-message.mdx
  • api/analytics/assistant-caller-stats.mdx, assistant-conversations.mdx, feedback.mdx, feedback-by-page.mdx, searches.mdx, views.mdx, visitors.mdx
  • api/assistant/create-assistant-message.mdx, create-assistant-message-v2.mdx, get-page-content.mdx, search.mdx
  • api/preview/trigger.mdx
  • api/update/status.mdx, trigger.mdx

Notes

  • Only frontmatter was modified — no page content or OpenAPI spec changes.
  • mint broken-links passes.

Note

Low Risk
Low risk because this PR only adjusts MDX frontmatter metadata (descriptions) and removes some description fields so API pages inherit OpenAPI-provided descriptions; no runtime code or API behavior changes.

Overview
SEO/frontmatter cleanup across docs. Updates several non-API pages to use more specific, search-friendly description strings.

For OpenAPI-backed reference pages (agent v1/v2, assistant, analytics, preview/update), removes the frontmatter description so the per-operation description from the OpenAPI spec is used instead (avoiding unintended overrides).

Reviewed by Cursor Bugbot for commit a9de63a. 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, 3:28 AM

@mintlify mintlify Bot merged commit 2016c35 into main May 2, 2026
5 checks passed
@mintlify mintlify Bot deleted the mintlify/seo-metadata-audit-1777691514 branch May 2, 2026 04:32
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