Skip to content

Documentation quality check: fix labels, flags, and coverage gaps - #7212

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/fc9ccfad
Open

Documentation quality check: fix labels, flags, and coverage gaps#7212
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/fc9ccfad

Conversation

@mintlify

@mintlify mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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/mint and mintlify/server codebases 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)
    • Gap: the save step referenced a Save as commit button that doesn't exist. The editor's actual label is Save in branch (verified in the dashboard CTA code). Fixed the label.
    • Gap: the "Merge branches" section was a single sentence with no actionable path. Added web editor and local development steps and linked /editor/publish.
  • cli/commands.mdx (+ es/fr/zh mirrors)
    • Gap: --groups was described as comma-separated on mint dev, mint validate, and mint 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)
    • Gap: the Create draft pull requests by default toggle in the Publishing section was undocumented. Added a section describing its behavior and default (on, verified in server constants).
    • Gap: didn't state that publishing settings require deployment-update permission. Added a sentence to the Publishing overview.
  • ai/bring-your-own-model.mdx (+ es/fr/zh mirrors)
    • Gap: the provider table said Anthropic and OpenAI-compatible coverage was "limited" without naming affected products. Verified in the model factory service that only the assistant uses BYOK on those providers while the agent and automations stay on Mintlify's models. Named the products and added a note that OpenRouter gives full coverage.

Best-practices pass

  • Mirrored all English changes into es/, fr/, and zh/, following each file's existing conventions (English UI labels, <div id> heading anchors, language-prefixed internal links).
  • SEO: shortened descriptions over the 160-character limit on es/editor/settings, es/ai/bring-your-own-model, fr/editor/settings, fr/ai/bring-your-own-model, and over the halved CJK limit on zh/cli/commands and zh/ai/bring-your-own-model.
  • mint validate and mint broken-links pass; 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: --groups on mint dev, mint validate, and mint export is 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.

@mintlify

mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Sep 1, 2026, 10:20 AM

@mintlify

mintlify Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Sep 1, 2026, 10:19 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants