Skip to content

Documentation quality check: address reader-question gaps - #6922

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/69720f6e
Open

Documentation quality check: address reader-question gaps#6922
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/69720f6e

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Summary

Fills gaps that a reader would reasonably expect but couldn't find on 10 pages updated in the last day.

Changes

  • editor/pages.mdx — Gap: mode-toggle shortcut conflicted with editor/keyboard-shortcuts.mdx. Fix: restored Cmd/Ctrl + Shift + S (the value set by the earlier code-driven update); the recent brand-tone rewrite had reverted it to M.
  • api-playground/mdx-setup.mdx — Gap: no guidance on adding request/response code samples to MDX API pages. Fix: added a pointer to the <RequestExample> and <ResponseExample> components.
  • deploy/reverse-proxy.mdx — Gap: description promised Nginx, Apache, and Caddy examples but only Nginx is shown. Fix: dropped the platform-specific list from the description.
  • deploy/route53-cloudfront.mdx — Gap: description mentioned Lambda@Edge functions that aren't used anywhere in the guide. Fix: removed the Lambda@Edge phrase from the description.
  • integrations/privacy/osano.mdx — Gap: didn't say where to place osano.js for Mintlify to pick it up. Fix: clarified that any .js file in the content directory is loaded automatically.
  • automations/create.mdx — Gap: covered create and delete but not editing an existing custom automation. Fix: added a short "Edit a custom automation" section pointing at the same settings entry point.
  • dashboard/network-access.mdx — Gap: didn't say whether the IP allowlist accepts IPv6. Fix: added an IPv6 example and CIDR example, and stated that both address families are supported.
  • organize/navigation.mdx — Gap: stated the "one child type per level" rule but not what happens when it's violated. Fix: added a note that mixing incompatible children fails schema validation, and pointed at mint validate.
  • optimize/feedback.mdx — Gap: didn't mention that feedback can be exported for external analysis. Fix: linked to the CSV export flow on the analytics page.
  • search-index/index.mdx — Gap: said the REST API requires an Index API key but gave no path to obtain one. Fix: linked "Index API key" to the authentication section of the Index API introduction.

Context

Scheduled quality check over English MDX files changed between 2026-08-07 and 2026-08-08. Files without material gaps (or where a proposed fix wasn't verifiable from the repo) were left untouched.


Note

Low Risk
MDX documentation and locale parity only; no runtime, auth, or deployment logic changes.

Overview
Fills documentation gaps identified in a quality pass—no product code changes. The same substantive fixes are applied in English and mirrored in es, fr, and zh where those pages exist.

Editor & API docs: editor/pages.mdx restores the visual/source mode shortcut to Cmd/Ctrl + Shift + S, matching editor/keyboard-shortcuts.mdx. api-playground/mdx-setup.mdx points authors to <RequestExample> / <ResponseExample> for sidebar code samples.

Deploy & integrations: Reverse-proxy and Route 53/CloudFront meta descriptions no longer promise Nginx/Apache/Caddy-only or Lambda@Edge content that the guides do not cover. Osano setup now states that any .js file under the content directory is auto-included on every page.

Product workflows: Automations gains an Edit a custom automation section. Dashboard IP allowlist documents IPv6 examples and explicit IPv4/IPv6 support. Navigation nesting notes that incompatible child types fail schema validation and recommends mint validate. Feedback links CSV export from analytics; Mintlify Index links how to obtain an Index API key.

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

@mintlify

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

@mintlify

mintlify Bot commented Aug 8, 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 Aug 8, 2026, 10:17 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