Documentation quality check: close reader-question gaps#6437
Open
mintlify[bot] wants to merge 2 commits into
Open
Documentation quality check: close reader-question gaps#6437mintlify[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
1 participant
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
Two-phase quality review of MDX pages updated in the last 24 hours; added content where readers had unanswered core questions.
Changes
agent/index.mdx— Gaps: no starting steps, no consolidated safety boundaries. Added a Get started section (dashboard → GitHub App → first request → review PR) and a How the agent stays safe section (PR-only, scoped repos, read-only source repos, human review).agent/slack.mdx— Gaps: channel visibility rules, no uninstall guidance. Clarified that the agent only responds in channels it's invited to (/invite @mintlify) and added a Disconnect the agent subsection.automations/manage.mdx— Gap: no guidance for interpreting a Failed run. Added a Troubleshoot a failed run subsection covering how to inspect the run, common causes (repo access, revoked tokens, invaliddocs.json), and retry behavior.automations/reference.mdx— Gap: page listed only predefined automations with no pointer to custom ones. Added a one-line link to Create a custom automation.create/changelogs.mdx— Gap: entry ordering was undocumented. Added a note that entries render in source order and to add new entries at the top.deploy/authentication-setup.mdx— Gap: no guidance for testing auth before going live. Added a Test your configuration subsection covering preview deployments, test users/groups, andmint devbehavior.deploy/export.mdx— Gap: unclear which features work offline. Added a Feature support subsection listing what's supported (navigation, images, code, Mermaid) vs. not (search, assistant, API playground, analytics, feedback, auth).editor/branching-and-publishing.mdx— Gaps: vague conflict UI, no rollback guidance. Expanded Resolve conflicts into a 4-step procedure and added a Revert a published change section covering GitHub/GitLab revert flow.optimize/feedback.mdx— Gaps: no explicit enablement steps, no reader-facing UI description. Added an Enable feedback section and a How readers submit feedback section describing widgets on the published site.optimize/pdf-exports.mdx— Gaps: no timing expectations, no automation info. Added a Note covering typical export duration, dashboard fallback for missing emails, and that exports are manual-only.Context
Triggered by the scheduled Documentation quality check workflow reviewing files changed between 2026-07-07 and 2026-07-08.
Note
Low Risk
Documentation-only MDX additions with no application or infrastructure changes.
Overview
Fills gaps from a documentation quality review by adding reader-focused sections across English guides and matching es, fr, and zh pages.
Agent — New Get started and How the agent stays safe on the agent overview; Slack docs gain Disconnect the agent, channel invite rules (
/invite @mintlify), and DM behavior.Automations & changelogs — Troubleshoot a failed run on manage; a custom-automation link on the predefined reference; changelog ordering note (newest at top).
Deploy & editor — Auth Test your configuration; offline export Feature support; editor conflict resolution steps and Revert a published change (GitHub/GitLab).
Optimize — Feedback enablement and reader submission UI; PDF export timing, dashboard retry, and manual-only exports.
Reviewed by Cursor Bugbot for commit 8dda1f4. Bugbot is set up for automated code reviews on this repo. Configure here.