Documentation quality check: fix gaps in recently changed pages - #7139
Open
mintlify[bot] wants to merge 2 commits into
Open
Documentation quality check: fix gaps in recently changed pages#7139mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
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. |
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
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
Documentation-only updates across English and localized MDX; no application or infrastructure code changes.
Overview
This PR closes documentation gaps found in recently changed pages and mirrors the same fixes in es, fr, and zh locales.
Admin MCP (
ai/mintlify-mcp.mdx): The docs no longer claim that all MCP changes go through a branch and PR. Content edits are scoped to branch +save; a new Deployment management section documents code-mode toolssearch_code_operationsandexecute_code, with a warning that those writes hit the live deployment immediately.POC onboarding (
poc-onboarding.mdx): Corrects mistaken auth domain requirements (.mintlify.siteis supported, not only custom domain /*.mintlify.app) and adds links to authentication setup in the participants table, domain note, and week-1 timeline.Route 53 + CloudFront (
deploy/route53-cloudfront.mdx): Overview cache policy text now matches the steps (CachingOptimized instead of CachingEnabled), and Route 53 steps are preceded by adding the domain as a CloudFront alternate name with an ACM certificate.Editor (
editor/pages.mdx): Adds Delete a page (Move to trash, undo, publish commit, Remove from publishing, private-page behavior).CLI (
cli/commands.mdx): Adds a one-line pointer to CLI install at the top of the command reference.Reviewed by Cursor Bugbot for commit 1ed422d. Bugbot is set up for automated code reviews on this repo. Configure here.