Documentation quality check: fix gaps in recently changed pages - #7139
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- route53-cloudfront: split the Route 53 section into "Add your domain to the distribution" and "Create the Route 53 record", give the alternate domain name / ACM step numbered steps and the console path, and warn that CloudFront only accepts certificates issued in us-east-1 - cli/commands: drop the intro sentence that restated the frontmatter description; match the link text to the target page title - poc-onboarding: stop coupling DNS setup to authentication in the participants table, since auth works on .mintlify.site - editor/pages: note that "Move to trash" has no trash view to restore from, and that recovery after publishing is through the repository Mirrored into es, fr, and zh. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
ethanpalm
approved these changes
Aug 31, 2026
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
1 participant
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
Reviewed the 19 English MDX pages changed in the last day, evaluated each for reader-facing gaps, and fixed the five highest-cost issues. All fixes were verified against the
serverandmintcodebases or the page's own linked sources. A follow-up best-practices pass mirrored every change into the Spanish, French, and Chinese translations.Changes
poc-onboarding.mdx*.mintlify.appsubdomain, contradicting/deploy/authentication-setup(auth works on.mintlify.site, verified in server auth code). This wrong prerequisite could push evaluators into 1–2 hours of unnecessary DNS work./deploy/authentication-setupfrom the domain note, the participants table, and the timeline.ai/mintlify-mcp.mdxsearch_code_operationsandexecute_code, and added a warning that code-mode writes apply immediately with no PR safety net.deploy/route53-cloudfront.mdxeditor/pages.mdxcli/commands.mdxmintbinary./cli/installat the top.Translations
es/,fr/, andzh/counterparts (15 files), following repo conventions:<div id>English-slug heading anchors, language-prefixed internal links, English UI labels preserved.poc-onboardingfiles, since the link is now inline, matching the English."HTML entities with real quotes ines/deploy/route53-cloudfront.mdx.docs.jsonstructural changes in this PR, soes.json/fr.json/zh.jsonneeded no updates. SEO, typo, and style checks on the five English files found nothing to fix;mint validateandmint broken-linksboth pass.Gaps deliberately left unfixed
deploy/ghes.mdx: supported GHES versions are not stated, but no version constraint is verifiable in the repos. Needs input from the team rather than an invented range.deploy/route53-cloudfront.mdx: the "Check that you set up behaviors correctly" screenshot shows 4 behaviors but the text now requires 6. Needs a regenerated screenshot.integrations/analytics/google-tag-manager.mdx: no "find your tag ID" section; the GTM UI location isn't verifiable from the repos, so nothing was invented.Also worth reviewing (low severity, not touched)
integrations/analytics/clarity.mdx: could link verification guidance from the analytics overview.ai/skillmd.mdx: could state that custom skill files go live with the normal deploy rather than the 24-hour regeneration cycle (verifiable in server deploy code).ai/llmstxt.mdx: typo "ins't" in the final note.Pages evaluated with no gaps:
deploy/preview-deployments.mdx,api/preview/trigger.mdx,help-center/preview-deployment-not-created-for-fork-branch.mdx,deploy/deployments.mdx,analytics/user-engagements.mdx,editor/index.mdx,quickstart.mdx,guides/git-concepts.mdx,changelog.mdx,ai/skillmd.mdx(low only).Note
Low Risk
Changes are MDX documentation and translations only; no application code, auth logic, or infrastructure behavior is modified.
Overview
Documentation-only updates across five English topics and mirrored es, fr, and zh pages to close reader-facing gaps found in a recent quality pass.
Admin MCP (
ai/mintlify-mcp.mdx): Separates content edits (branch +save/ PR) from deployment management (immediate live changes). Adds a Deployment management section for code mode (search_code_operations,execute_code) and warnings that those writes skip branches and PRs.POC onboarding (
poc-onboarding.mdx): Corrects authentication hosting (works on.mintlify.siteor custom domain, not custom subpaths). Reframes IT/identity admin tasks (IdP for auth testing, DNS only when adding a custom domain) and links authentication setup from the timeline and domain note.Route 53 / CloudFront (
deploy/route53-cloudfront.mdx): Aligns overview cache policy naming to CachingOptimized and documents alternate domain (CNAME) + ACM (us-east-1) before creating the Route 53 alias record.Editor (
editor/pages.mdx): Adds Delete a page (trash vs Remove from publishing, roles); localized pages include extra undo/repo/private-page detail.CLI (
cli/commands.mdx): Adds a one-line link to Install the CLI at the top of the command reference.Reviewed by Cursor Bugbot for commit 7bbc392. Bugbot is set up for automated code reviews on this repo. Configure here.