Documentation quality check: fix labels, flags, and coverage gaps - #7212
Open
mintlify[bot] wants to merge 2 commits into
Open
Documentation quality check: fix labels, flags, and coverage gaps#7212mintlify[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
Quality review of the 18 English MDX pages changed in the last day found real gaps on 4 pages, all verified against the
mintlify/mintandmintlify/servercodebases before fixing. A follow-up best-practices pass mirrored the changes into Spanish, French, and Chinese and fixed SEO metadata defects on the translated pages.Changes
guides/branches.mdx(+ es/fr/zh mirrors)/editor/publish.cli/commands.mdx(+ es/fr/zh mirrors)--groupswas described as comma-separated onmint dev,mint validate, andmint export, but the CLI defines it as a space-separated array (--groups admin user) with no comma splitting. Corrected all three flag descriptions with an example.editor/settings.mdx(+ es/fr/zh mirrors)ai/bring-your-own-model.mdx(+ es/fr/zh mirrors)Best-practices pass
es/,fr/, andzh/, following each file's existing conventions (English UI labels,<div id>heading anchors, language-prefixed internal links).es/editor/settings,es/ai/bring-your-own-model,fr/editor/settings,fr/ai/bring-your-own-model, and over the halved CJK limit onzh/cli/commandsandzh/ai/bring-your-own-model.mint validateandmint broken-linkspass; no broken links, typos, or style issues found in the changed files.Gaps deliberately left unfixed
api/search-index/introduction.mdx: how organizations get Index REST API access. Access is gated by an entitlement, but the plan-to-entitlement mapping isn't verifiable from the repos, so documenting it would risk invented detail.deploy/route53-cloudfront.mdx: screenshot caption says 4 behaviors while the instructions create 6. Fixing requires a new screenshot.reference/glossary.mdx: optional authentication/personalization entries (low value, glossary isn't obligated to be exhaustive).All other evaluated pages (
api-playground/openapi-setup,automations/create,automations/integrations,ai/mintlify-mcp,assistant/configure,integrations/privacy/osano,help-center/branch-missing-from-editor-branch-list,editor/pages,components/mdx,create/list-table,poc-onboarding) had no real gaps.Note
Low Risk
Documentation-only corrections with no runtime or security impact; reduces user misconfiguration from wrong CLI syntax or outdated UI labels.
Overview
This PR aligns docs with product behavior after a quality pass against the Mintlify CLI and dashboard, with the same fixes mirrored in es, fr, and zh.
CLI:
--groupsonmint dev,mint validate, andmint exportis documented as space-separated (e.g.--groups admin user), not comma-separated.Editor & branches: The web editor save control is corrected to Save in branch (replacing Save as commit). The merge-branches section now gives web editor and local Git steps and links to publishing docs.
Editor settings: Publishing settings note that changing them needs deployment-update permission. English adds documentation for Create draft pull requests by default (on by default); locale pages are tightened to match.
Bring your own model: Anthropic and OpenAI-compatible rows now state that only the assistant uses your key while agent and automations stay on Mintlify models, with a pointer to OpenRouter for full coverage.
Reviewed by Cursor Bugbot for commit a661c10. Bugbot is set up for automated code reviews on this repo. Configure here.