Documentation quality check: close reader gaps on 3 recently updated pages

[mintlify]

Summary

Reviewed the 30 English MDX files touched between 2026-09-21 and 2026-09-22 for reader-question coverage and fixed the three pages with the highest-impact gaps.

Changes

deploy/ci.mdx

• Gap: The intro description promised "grammar validation, and build previews," but the "Available CI checks" section only documents broken links and Vale. Readers arriving from search would expect checks that don't exist.
• Fix: Trimmed the description to accurately list broken link detection and Vale prose linting.

migration-services/go-live-checklist.mdx

• Gap 1 (redirects): The redirects bullet only linked to the reference page, with no guidance on how to test redirects before launch.
• Fix: Added a sub-bullet pointing readers to preview deployments (which apply redirects) and to local testing with mint dev, both of which are documented on /create/redirects.
• Gap 2 (authentication): The security section covered configuring auth but not verifying it works before going live.
• Fix: Added a sub-bullet instructing readers to sign in as a test user per user group and to confirm signed-out visitors are blocked from private pages.

deploy/deployments.mdx

• Gap: When latest changes weren't appearing, the page only surfaced one cause (missing GitHub App). It didn't mention build failures visible in deployment history or pushing to the wrong deployment branch — both common issues.
• Fix: Replaced the single-cause paragraph with an ordered troubleshooting list: check activity page for build errors, verify the deployment branch matches what you pushed to, then verify the GitHub App is installed. Each item links to the existing dashboard or troubleshooting page.

Gaps deliberately left unfixed

• dashboard/security-contact.mdx — page doesn't enumerate what kinds of communications actually get sent to the security contact, whether distribution lists are supported, or what happens when no contact is set. The server-side code stores the field but no email-sending logic references it, so I can't verify concrete event types without inventing detail.
• editor/agent.mdx — no "Limits and privacy" section covering message/rate limits, model, or data handling. I couldn't verify these specifics from the repos.
• help-center/agent-opens-pull-requests-against-deploy-branch.mdx — slight ambiguity about what happens when the branch named in a prompt doesn't yet exist; the current phrasing ("creates the pull request against the branch you name, or pushes commits directly to it when the branch already exists") implicitly covers creation but could be clearer.

Also worth reviewing

Lower-severity gaps not fixed in this run:

• ai-native.mdx — plan gating for AI features isn't summarized on the overview.
• analytics/index.mdx — analytics data retention window isn't stated.
• api/automations/webhook.mdx — success response shape and non-404 error codes aren't summarized.
• deploy/export.mdx — no concrete pointer to a static search tool; doesn't state whether auth can be added to exports.
• editor/review.mdx — doesn't say where to leave PR review comments or request changes.
• help-center/can-i-rename-my-deployment-or-organization.mdx — doesn't explicitly reassure that renaming a deployment or org leaves URLs unchanged.
• help-center/domain-already-claimed-by-another-organization.mdx — doesn't state whether there's serving downtime during a domain transfer.
• help-center/llms-txt-returns-404-but-llms-full-txt-works.mdx — no explicit verification step after the redeploy.
• optimize/search.mdx — no note on when search configuration changes take effect.
• organize/related-pages.mdx — doesn't describe how automatic suggestions are ranked or when the index refreshes.
• editor/settings.mdx — selective publishing default beyond "off by default" is not called out.

---

Note

Low Risk
Documentation-only copy updates across locales; no product code or runtime behavior changes.

Overview
This PR tightens reader-facing docs on CI, deployments troubleshooting, and the go-live checklist, with the same edits mirrored in es, fr, and zh.

On deploy/ci.mdx, the page meta description no longer mentions grammar validation or build previews; it now matches what the page documents—broken link detection and Vale prose linting.

On deploy/deployments.mdx, the “changes not appearing” guidance is an ordered checklist: confirm a build on the activity page (and read failures), verify pushes hit the configured deployment branch, then (for GitHub) confirm the Mintlify GitHub App is still installed. Manual deploy is framed as the next step only when connection and branch are correct but no build ran.

On migration-services/go-live-checklist.mdx, two pre-launch bullets were added: test authenticated access per user group (including signed-out visitors on private pages), and test redirects via preview deployments or local mint dev.

^{Reviewed by Cursor Bugbot for commit 18b61a4. Bugbot is set up for automated code reviews on this repo. Configure here.}

[mintlify]

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

Project	Status	Preview	Updated
mintlify	🟢 Ready	View Preview	Sep 22, 2026, 10:15 AM