Documentation quality check: fix prerequisite and clarity gaps

[mintlify]

Summary

Quality review of the 27 English MDX pages changed in the last day surfaced real gaps on 5 pages; each fix is verified against the codebase or existing docs.

Changes

• cli/commands.mdx
  • Gap: the new mint test section omitted prerequisites; the command fails without mint login and an installed agent SDK (verified in mintTest.tsx and loadAgentSdk.ts).
  • Gap: the section said tests are generated but not that they are executed, or what the result output means.
  • Added a Prerequisites subsection (login + Claude/Codex SDK install commands) and a sentence on the run summary output and exit codes.
• automations/create.mdx
  • Gap: Prerequisites omitted the plan requirement stated on the automations overview, so readers landing here directly hit an undisclosed plan gate.
  • Added the Pro/Enterprise plan requirement (Enterprise for the Integration trigger) to Prerequisites.
• automations/integrations.mdx
  • Gap: no plan requirement stated, though agent/slack.mdx and automations/index.mdx both gate integrations on Enterprise.
  • Added an Enterprise plan callout matching the existing pattern.
• editor/agent.mdx
  • Gap: "makes changes directly in your current branch" could read as publishing immediately.
  • Clarified that agent edits save automatically but require publishing to reach the live site, consistent with editor/index.mdx.
• search-index/connect.mdx
  • Gap: the page claims support for 7 agents but gave manual configuration for only Claude Code and Cursor.
  • Added manual config tabs for VS Code, Codex, OpenCode, Windsurf, and Zed (config paths, keys, and entry shapes verified against the CLI's indexSetup/clients.ts).

Also worth reviewing

• api-playground/adding-sdk-examples.mdx: could note that any generator writing x-codeSamples works (Stainless page now redirects here).
• deploy/gitlab.mdx: webhook section could link to /deploy/preview-deployments and /deploy/gitlab-self-hosted.
• help-center/configure-oauth-with-auth0.mdx: intro anchor /deploy/authentication-setup#oauth-2-0 doesn't match a real heading (content is in a Tab).
• deploy/vercel.mdx: basic /docs flow lacks a verification step.

Open gaps left unfixed (unverifiable)

• ai/model-context-protocol.mdx: contradicts itself on whether the authenticated MCP server is auto-enabled or needs manual enabling; correct behavior couldn't be confirmed from the reference repos.
• editor/pages.mdx: whether trashed pages can be restored is undocumented and unverifiable.
• automations/manage.mdx: whether predefined automations are deletable from the dashboard is ambiguous and unverifiable.
• migration/document360.mdx: no HTML/JSON→MDX conversion method exists to document without recommending unverified external tooling.

---

Note

Low Risk
Documentation-only changes with no application code, auth, or data-handling impact.

Overview
This PR tightens documentation accuracy after a quality pass: plan gates, mint test behavior, editor publish flow, and Index manual setup for all supported agents. The same edits are mirrored in es, fr, and zh where those pages exist.

Automations — Custom automation prerequisites now state Pro/Enterprise (Enterprise for the Integration trigger). The integrations page adds an Enterprise callout so plan requirements match other automation docs.

CLI (mint test) — The command is described as generating and running tests with a local coding agent, not only generating them. New Prerequisites cover mint login and Claude/Codex SDK installs; output docs explain the run summary line and exit codes 0/1.

Editor agent — Clarifies that agent edits auto-save on the branch but do not go live until publish, avoiding the impression that branch edits ship immediately.

Mintlify Index (search-index/connect) — Manual setup intro is generalized beyond Claude/Cursor. New tabs document MCP config for VS Code, Codex, OpenCode, Windsurf, and Zed (paths and config shapes).

^{Reviewed by Cursor Bugbot for commit 4c3477c. 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 4, 2026, 10:15 AM

[mintlify]

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

Project	Status	Preview	Updated
tomee	🟡 Building	–	Sep 4, 2026, 10:14 AM

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