Documentation quality check: address reader-question gaps - #6954
Closed
mintlify[bot] wants to merge 2 commits into
Closed
Documentation quality check: address reader-question gaps#6954mintlify[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. |
Collaborator
|
closing in favor of #7200 |
ethanpalm
added a commit
that referenced
this pull request
Aug 31, 2026
…ages (#7200) * docs: close reader-question gaps in automations, go-live, and Osano pages Reworks the English-only subset of #6954 after review. - automations/create.mdx: replace the redundant "review the output" tip with a "Test your automation" section. Drops #6954's advice to test before relying on "a schedule or event"; per /automations/manage most automations can run manually only with a schedule trigger. Links the run history section rather than the raw dashboard URL so credit usage and run statuses stay documented in one place. - migration-services/go-live-checklist.mdx: add the preview-URL and mint broken-links steps to the existing Content validation section instead of a new section. #6954's auth and page-access bullets duplicated the Security section, and its redirects bullet is folded into the existing one. - integrations/privacy/osano.mdx: add a Verify the banner section and note that content-directory .js files need no docs.json entry. Excludes #6954's editor/tutorial.mdx prerequisites: the Editor group root already documents editor access and roles, and the connected-repo bullet is wrong for projects that skipped Git setup during onboarding. The network-access.mdx lockout section is held pending confirmation of what support can do for a locked-out org. Translations omitted; they are generated after merge. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * Apply batched suggestions from code review Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com> --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
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
2 participants
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
Reviewed the 50 English MDX files updated in the last 24 hours against Diataxis-scoped reader questions. Five pages had real gaps that would cost a reader; the rest either answered every question or had only cosmetic issues.
Changes
dashboard/network-access.mdxsupport@mintlify.comwith the details support needs to help.editor/tutorial.mdxmigration-services/go-live-checklist.mdx.mintlify.sitepreview URL,mint broken-links, redirect spot-checks, and access-group verification.automations/create.mdx/automations/manage#run-an-automation-manuallyand describing how to inspect run history.integrations/privacy/osano.mdxosano.jsneeds to be registered somewhere indocs.json..jsfiles from the content directory (linked to/customize/custom-scripts#custom-javascript) and a Verify the banner section.Also worth reviewing
These pages had smaller gaps flagged during the pass but weren't fixed this run:
assistant/widget.mdx— signed identity token generation isn't explained for authenticated embeds.editor/agent.mdx— no clear path to reject/undo agent edits after review.search-index/index.mdx— doesn't explain how content enters the index or whether there are limits/pricing.guides/developer-documentation.mdx— SDK docs are listed in the nav example but never authored/organized.analytics/streaming.mdx— delivery guarantees, retries, and backfill semantics aren't documented.analytics/search.mdx— CTR formula and no-result-query workflow are underspecified.analytics/traffic.mdx— page-view definition and referral attribution rules aren't stated.Validation
mint validate— passedmint broken-links— passedNote
Low Risk
Changes are MDX documentation and translations only; no application code, config defaults, or security behavior changes in the product.
Overview
Documentation-only updates across English and localized (
es,fr,zh) pages to answer gaps found in a Diataxis-style reader review.Dashboard IP allowlist (
network-access.mdx): adds Recover from a lockout with steps to contactsupport@mintlify.com(org name and IP) when admins are locked out.Editor tutorial (
editor/tutorial.mdx): adds Prerequisites (connected repo, editor account, permission to open PRs) so new readers don’t start without setup.Go-live checklist (
go-live-checklist.mdx): adds Pre-launch validation—preview on.mintlify.site, localmint broken-links, redirect checks, and access-group sign-in verification before DNS cutover.Custom automations (
automations/create.mdx): adds Test your automation—manual run before schedules/events, link to manual run docs, and how to inspect runs on the Automations runs tab.Osano integration (
integrations/privacy/osano.mdx): clarifies that content-directory.jsfiles are auto-included (nodocs.jsonentry forosano.js) and adds Verify the banner after deploy.Reviewed by Cursor Bugbot for commit 4f88e3a. Bugbot is set up for automated code reviews on this repo. Configure here.