Skip to content

Improve SEO metadata across documentation pages#5449

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-audit-1776676147
Closed

Improve SEO metadata across documentation pages#5449
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/seo-audit-1776676147

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 20, 2026

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 description fields 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)

  • No missing titles or descriptions on non-API pages
  • No titles over 60 characters
  • No boilerplate title patterns
  • No descriptions over 160 characters
  • No duplicate descriptions across pages

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 description fields (e.g., Linear agent, assistant settings/customization, cards, visibility, enterprise contracting) to be more specific and keyword-rich.

Removes redundant description frontmatter from multiple API reference MDX pages that already declare openapi operations, 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.

… page descriptions

Generated-By: mintlify-agent
@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 20, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 20, 2026, 9:14 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 Apr 20, 2026, 9:11 AM

@ethanpalm ethanpalm closed this Apr 20, 2026
@ethanpalm ethanpalm deleted the mintlify/seo-audit-1776676147 branch April 20, 2026 17:07
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.

1 participant