Skip to content

docs: address content gaps from weekly page review#6241

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/369054d4
Open

docs: address content gaps from weekly page review#6241
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/369054d4

Conversation

@mintlify

@mintlify mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Summary

Weekly two-phase quality review of recently updated English pages surfaced answerability gaps; this PR closes them.

Changes

automations/index.mdx

  • Gap: Page said runs "count toward credit usage" but didn't explain what determines per-run cost.
  • Fix: Added a sentence describing the drivers of per-run credit usage (content read, files changed, run length, context size).

automations/create.mdx

  • Gap: Creation steps listed the config fields (trigger, instructions, context repos, integrations, update mode) without describing them or linking to where they're documented.
  • Fix: Added an inline cross-link to Configurations on automations/manage from step 3.

automations/manage.mdx

  • Gap 1: No coverage of running an automation manually on demand.
  • Gap 2: Run history mentioned "status" without enumerating which statuses exist.
  • Fix: Added a new "Run an automation manually" section and a status reference list (Queued, In progress, Succeeded, Failed, No changes) under "View run history."

automations/reference.mdx

  • Gap: Frontmatter promised default trigger, update mode, context-repo support, and required configuration per automation, but most entries described behavior in prose without explicit defaults.
  • Fix: Added an "At a glance" summary table at the top of the page with one row per predefined automation covering all four attributes.

dashboard/sso.mdx

  • Gap 1: No documentation for SSO-only sign-in enforcement (shipped June 19, 2026).
  • Gap 2: No documentation for verified domains (shipped June 19, 2026).
  • Gap 3: No documentation for breakglass emails / emergency access (shipped June 19, 2026).
  • Fix: Added three new sections — "Enforce SSO-only sign-in," "Verified domains," and "Breakglass emails" — between JIT provisioning and the RBAC mapping section.

deploy/authentication-setup.mdx

  • Gap: Feature-availability table still listed PDF export as "Not supported" for authenticated sites, contradicting the June 19, 2026 changelog (full PDF export with auth cookies parsed, images/assets included).
  • Fix: Updated the PDF export row to reflect full support for both fully and partially authenticated sites, noting that exports respect user groups and include images and assets.

editor/branching-and-publishing.mdx

  • Gap: Page covered the publish-menu diff list but didn't mention the new entry points for opening an automation run's changed pages directly in the editor (from the run review UI or Slack), or that highlighted/unlisted pages in the branch diff are openable.
  • Fix: Extended "Review changes before merging" to note highlighted changed pages and openable unlisted pages, and added a new "Open an automation run in the editor" subsection covering the dashboard and Slack entry points.

Context

Generated by the weekly page-review workflow against pages affected by the June 19, 2026 release.


Note

Low Risk
Documentation-only MDX changes with no application code, auth logic, or runtime behavior modified.

Overview
This PR closes answerability gaps from a weekly docs review by expanding English pages and mirroring the same updates in es, fr, and zh where applicable.

Automations docs now explain what drives per-run credit usage, link custom automation setup to Configurations, document manual runs and run statuses (Queued through No changes), and add an At a glance table of predefined automation defaults.

SSO gains three new sections: SSO-only enforcement, verified domains (DNS TXT, up to five), and breakglass emails for emergency access.

Authentication setup corrects PDF export on protected sites from “not supported” to full support with user groups and included assets. Editor pages describe highlighted branch diffs, unlisted pages in the publish menu, and opening automation runs via Open in editor or Slack View changes.

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

@mintlify

mintlify Bot commented Jun 23, 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 Jun 23, 2026, 10:17 AM

@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
smartac 🟢 Ready View Preview Jun 23, 2026, 10:19 AM

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

@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
testsignup415 🟢 Ready View Preview Jun 23, 2026, 10:21 AM

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

@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
adminroletesting 🟢 Ready View Preview Jun 23, 2026, 10:25 AM

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

@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
hfh-d7a4d643 🟢 Ready View Preview Jun 23, 2026, 10:28 AM

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

@mintlify

mintlify Bot commented Jun 23, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
gwgwgw 🟢 Ready View Preview Jun 23, 2026, 10:29 AM

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

@mintlify

mintlify Bot commented Jun 23, 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 Jun 23, 2026, 10:32 AM

💡 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