Skip to content

docs: close reader-question gaps in automations, go-live, and Osano pages - #7200

Merged
ethanpalm merged 2 commits into
mainfrom
docs-quality-reader-gaps-english
Aug 31, 2026
Merged

ethanpalm merged 2 commits into
mainfrom
docs-quality-reader-gaps-english

Conversation

@ethanpalm

@ethanpalm ethanpalm commented Aug 31, 2026

Copy link
Copy Markdown
Collaborator

Reworks the English-only subset of #6954 after review. Three pages, +14/-4.

What changed

automations/create.mdx — Replaces the redundant "review the output of your custom automations" tip with a ## Test your automation section.

#6954 advised triggering a manual run "before relying on a schedule or event," which contradicts automations/manage.mdx: "Most automations can run manually only when they have a schedule trigger." For an event-triggered automation with no schedule — the exact case — the run button is unavailable. This version states the schedule-trigger requirement and links #view-run-history instead of the raw ?tab=runs dashboard URL, so credit usage and run statuses stay documented in the page that owns them.

migration-services/go-live-checklist.mdx — Adds the two genuinely new steps (preview URL, mint broken-links) to the existing Content validation section.

#6954 proposed a new ## Pre-launch validation section, but half of it now duplicates the page as rebuilt by #7143 and #7168: its auth/page-access bullet repeats Security, and its redirects bullet repeats Content validation. Redirect verification is folded into the existing redirects bullet instead.

integrations/privacy/osano.mdx — Adds ## Verify the banner and notes that content-directory .js files need no docs.json entry. Drops #6954's duplicate link to /customize/custom-scripts#custom-javascript, which the page's opening sentence already links.

Deliberately excluded from #6954

  • editor/tutorial.mdx prerequisites. editor/index.mdx is the root of the Editor nav group and already states that anyone in the org can open the editor while actions depend on your role. Two bullets were also wrong: readers don't need Git-provider PR permission (the editor opens PRs on their behalf, editor/settings.mdx:26), and the connected-repo bullet misleads anyone who skipped Git setup during onboarding, since Mintlify provisions a repo for them (quickstart.mdx:70).
  • dashboard/network-access.mdx lockout recovery. Real gap and worth documenting, but Documentation quality check: address reader-question gaps #6954 asserts that support "can add an address or disable the allowlist." Holding until someone confirms what support can actually do for a locked-out org.
  • All 15 es/fr/zh files. Translations are generated after merge.

Validation

  • mint validate — pass
  • mint broken-links — pass
  • mint a11y — pass (only pre-existing brand-palette contrast warnings)
  • vale on changed files — 0 errors, 0 warnings, 0 suggestions

Closes #6954.

🤖 Generated with Claude Code


Note

Low Risk
Documentation-only edits to user-facing guides; no product code or security behavior changes.

Overview
Automations create guide — Replaces the generic tip to “review output” with a Test your automation section. It tells readers to run the automation manually before depending on its trigger, points to manage docs for manual-run steps (including the schedule-trigger requirement for most automations), and explains how to use run history to inspect prompts, file changes, and PRs before iterating on instructions.

Osano integration — Clarifies that placing osano.js in the content directory is enough (no docs.json registration). Adds Verify the banner with post-deploy checks in a private window and console/script-URL troubleshooting before the existing troubleshooting accordion.

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

…ages

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>
@mintlify

mintlify Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 31, 2026, 6:37 PM

@mintlify

mintlify Bot commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Aug 31, 2026, 6:30 PM

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

Comment thread migration-services/go-live-checklist.mdx Outdated
Comment thread migration-services/go-live-checklist.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@ethanpalm
ethanpalm merged commit 58b6930 into main Aug 31, 2026
4 checks passed
@ethanpalm
ethanpalm deleted the docs-quality-reader-gaps-english branch August 31, 2026 21:02
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