Skip to content

Documentation quality check: fill gaps in recently updated pages#6733

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

Documentation quality check: fill gaps in recently updated pages#6733
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/5e4b4d00

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Two-phase quality review of English MDX files updated between 2026-07-23 and 2026-07-24 found five pages with reader questions the page couldn't answer. This PR fills those gaps.

Changes

agent/slack.mdx

  • Gap: No steps for removing the agent from Slack; only reconnect/reinstall was covered.
  • Fix: Added a ### Disconnect the agent subsection with dashboard and Slack-side removal steps and a note about in-progress runs.

automations/create.mdx

  • Gap 1: The sandbox Note said what the agent couldn't do but not what it could, leaving readers unable to predict which prompts will work.
  • Fix 1: Added an explicit list of allowed capabilities (read repo files, use configured integrations, edit MDX, open PRs) and blocked ones (arbitrary network, package installs, shell tools).
  • Gap 2: Step 3 offloaded every field description to another page, so the create flow wasn't followable end-to-end.
  • Fix 2: Added an inline bulleted description of each configuration field (Name, Trigger, Instructions, Context repositories, Integrations, Update mode), keeping the deep link for full details.

automations/manage.mdx

  • Gap: Page frontmatter promises "delete automations from your dashboard" but there was no delete section — only disable.
  • Fix: Added a ## Delete an automation section with dashboard steps, a note about the action being permanent, a callout that predefined automations can only be disabled, and a pointer to mint automations delete.

cli/commands.mdx

  • Gap 1: Users landing on the command reference had no pointer to installation.
  • Fix 1: Added a one-line link to /cli/install at the top of the page.
  • Gap 2: mint broken-links and mint a11y didn't document CI exit-code behavior even though the other CI-relevant commands do.
  • Fix 2: Added an explicit "exits with a non-zero status" note to both commands.

cli/index.mdx

  • Gap: No mention of Node.js version, OS, or how the CLI is distributed — a reader can't tell whether they can install it.
  • Fix: Added a one-line requirements sentence stating the CLI installs from npm and requires Node.js v20.17.0 or newer, with a link to the install page.

Pages reviewed with no gaps requiring changes: ai/markdown-export.mdx, ai/mintlify-mcp.mdx, ai/model-context-protocol.mdx, api-playground/sdk-reference-setup.mdx, automations/index.mdx, automations/integrations.mdx, create/reusable-snippets.mdx, deploy/self-host.mdx, optimize/analytics.mdx, optimize/feedback.mdx, organize/navigation.mdx.

Validation

  • mint validate — passed
  • mint broken-links — passed

Note

Low Risk
MDX documentation and translation parity only; no application code, APIs, or infrastructure changes.

Overview
This PR closes reader gaps on recently updated docs by adding missing procedural and reference detail in English and mirroring the same updates in es, fr, and zh.

Slack agent — New Disconnect the agent steps cover dashboard disconnect, removing the app in Slack, and behavior for in-progress runs.

Custom automations — The create flow now spells out sandbox capabilities and limits (read repos, integrations, MDX/PRs vs. no arbitrary network/shell) and inline field descriptions for Name, Trigger, Instructions, context repos, Integrations, and Update mode. Manage automations adds a Delete an automation section (permanent deletion, predefined automations, dashboard + mint automations delete).

CLI — The commands reference links to install at the top; mint broken-links and mint a11y document non-zero exit codes for CI. The CLI overview states npm install and Node.js v20.17.0+ with a link to the install page. Minor frontmatter tweaks on some automation pages.

Reviewed by Cursor Bugbot for commit 829e469. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jul 24, 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 Jul 24, 2026, 6:41 PM

@mintlify

mintlify Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 24, 2026, 6:41 PM

💡 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.

1 participant