Apply SEO and metadata best practices - #6750
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
approved these changes
Jul 27, 2026
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
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
Rewrote description frontmatter on 20 pages that fell outside the 130–160 character window recommended for search snippets.
Changes
en,es, andfr(e.g.automations/create.mdx,automations/index.mdx,enterprise-contracting.mdx,es/optimize/analytics.mdx,fr/deploy/self-host.mdx).migration-services/go-live-checklist.mdx,organize/related-pages.mdx,es/editor/comments.mdx).api/were left untouched — descriptions come from the specs.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
descriptionfrontmatter 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.mdxnow 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.