Skip to content

Apply SEO and metadata best practices - #6750

Merged
ethanpalm merged 2 commits into
mainfrom
mintlify/96d76bd3
Jul 27, 2026
Merged

Apply SEO and metadata best practices#6750
ethanpalm merged 2 commits into
mainfrom
mintlify/96d76bd3

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Rewrote description frontmatter on 20 pages that fell outside the 130–160 character window recommended for search snippets.

Changes

  • Shortened 15 descriptions that exceeded 160 characters across en, es, and fr (e.g. automations/create.mdx, automations/index.mdx, enterprise-contracting.mdx, es/optimize/analytics.mdx, fr/deploy/self-host.mdx).
  • Lengthened 5 descriptions that were under 130 characters (e.g. migration-services/go-live-checklist.mdx, organize/related-pages.mdx, es/editor/comments.mdx).
  • Titles were already unique and under 60 characters; no title changes were needed.
  • OpenAPI operation-reference pages under api/ were left untouched — descriptions come from the specs.
  • Reusable snippets under snippets/ were skipped — they are includes, not indexed pages.
  • zh/ pages were only checked for missing metadata; the 130–160 character rule targets Latin scripts and does not translate directly to CJK.

Context

Triggered by the initial docs commit b796c23, which added the full docs tree; the audit covered every MDX page in scope.


Note

Low Risk
Metadata-only frontmatter edits with no runtime or application logic changes; the MSA wording typo in enterprise-contracting is a content accuracy issue, not a deployment risk.

Overview
Updates description frontmatter only on 20 MDX pages across en, es, and fr so meta descriptions fit the ~130–160 character range used for search snippets. Page body content, titles, and keywords are unchanged.

Shortened descriptions that were too long (e.g. automations, self-host, analytics, GraphQL setup, editor pages). Expanded descriptions that were too short (e.g. go-live checklists, related topics). Wording was tightened or clarified in places (triggers, related-topics behavior, editor mentions).

Note: enterprise-contracting.mdx now says "Master Servicer Agreement" instead of "Master Service Agreement"—likely an accidental typo from the rewrite.

Reviewed by Cursor Bugbot for commit 390c85b. Bugbot is set up for automated code reviews on this repo. Configure here.

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 25, 2026, 12:20 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 25, 2026, 12:20 AM

Comment thread organize/related-pages.mdx Outdated
Comment thread enterprise-contracting.mdx Outdated
Comment thread automations/create.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@ethanpalm
ethanpalm merged commit 260111b into main Jul 27, 2026
4 checks passed
@ethanpalm
ethanpalm deleted the mintlify/96d76bd3 branch July 27, 2026 16:51
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.

2 participants