Skip to content

Documentation quality check: fill reader-question gaps - #6834

Merged
ethanpalm merged 3 commits into
mainfrom
mintlify/f7c19b52
Jul 31, 2026
Merged

Documentation quality check: fill reader-question gaps#6834
ethanpalm merged 3 commits into
mainfrom
mintlify/f7c19b52

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Summary

Reviewed recently updated English MDX pages, evaluated each against a set of reader questions, and filled in the concrete gaps that a reader would expect answered.

Changes

automations/create.mdx

  • Gap: Page jumped straight into prerequisites without defining a "custom automation" or contrasting it with predefined automations.
  • Fix: Added a short intro paragraph explaining what a custom automation is, when to use one instead of a predefined automation, and linking to the automations overview.

cli/preview.mdx

  • Gap: No troubleshooting guidance for common mint dev failures (missing/invalid docs.json, stale CLI, Node version, port conflicts, slow large-site loads). Readers hitting an error had nowhere to look.
  • Fix: Added a Troubleshoot the local preview section with a short bulleted checklist for the most common failure modes, plus a pointer to the CLI reference.

agent/slack.mdx

  • Gap: The Slack setup guide covered reconnecting and reinstalling but never explained how to remove the agent from a workspace.
  • Fix: Added a Disconnect the agent subsection with the steps to revoke the connection from the dashboard and remove the app from Slack, and a note about what stops working after disconnection.

Context

Scheduled documentation quality check across MDX files updated between 2026-07-30 and 2026-07-31. Other reviewed files were either already complete or had only speculative/tangential gaps and were left unchanged.


Note

Low Risk
MDX documentation edits only; no application code or configuration changes.

Overview
Documentation-only updates that answer common setup questions without changing product behavior.

agent/slack.mdx (English) adds a Disconnect the agent subsection before reconnect guidance: revoke via Automations → Configure SlackDisconnect, remove the app in Slack, and a note that mentions, DMs, and Slack-posting automations stop working. es, fr, and zh agent/slack.mdx get the same section (localized) with matching anchor IDs.

automations/create.mdx (English) gains opening paragraphs defining custom automations, when to use them vs predefined ones, and a link to the automations overview. es, fr, and zh versions receive equivalent intros.

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

@mintlify

mintlify Bot commented Jul 31, 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 31, 2026, 10:12 AM

@mintlify

mintlify Bot commented Jul 31, 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 31, 2026, 10:12 AM

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

Comment thread automations/create.mdx Outdated
Comment thread cli/preview.mdx Outdated
Comment thread es/cli/preview.mdx Outdated
Comment thread fr/cli/preview.mdx Outdated
Comment thread zh/cli/preview.mdx Outdated
Comment thread agent/slack.mdx Outdated
@ethanpalm
ethanpalm merged commit eacb75d into main Jul 31, 2026
4 checks passed
@ethanpalm
ethanpalm deleted the mintlify/f7c19b52 branch July 31, 2026 16:05

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Want higher recall? High effort reviews run extra passes and find more bugs. A team admin can switch effort levels in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit a0fd5d1. Configure here.

Comment thread es/agent/slack.mdx
2. Haz clic en **Disconnect Slack** para revocar la conexión entre Mintlify y tu workspace.
3. En Slack, abre **Settings & administration** > **Manage apps**, busca la aplicación `mintlify` y haz clic en **Remove**.

Después de desconectarlo, el agente deja de responder a menciones y mensajes directos, y las automatizaciones que publican en Slack dejan de entregar notificaciones. Puedes volver a conectarlo en cualquier momento siguiendo los pasos de [Conecta tu workspace de Slack](#connect-your-slack-workspace).

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Manual localized file edits

Medium Severity

This PR edits es/, fr/, and zh/ pages directly, but project guidance requires English-only doc updates so the translation workflow can sync locales after merge. Manual localized edits risk shipping divergent or wrong content and conflicting with that automation.

Additional Locations (2)
Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit a0fd5d1. Configure here.

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.

2 participants