Skip to content

Documentation quality check: close reader-question gaps#6407

Merged
ethanpalm merged 10 commits into
mainfrom
mintlify/c1f26e90
Jul 7, 2026
Merged

Documentation quality check: close reader-question gaps#6407
ethanpalm merged 10 commits into
mainfrom
mintlify/c1f26e90

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Reviewed MDX pages updated since the previous run and added missing content that answers questions a reader would naturally expect the page to address.

Changes

agent/index.mdx

  • Gap: Page described what the agent does but never explained how to actually invoke it.
  • Fix: Added a "Send your first request" section pointing to the Agent dashboard page and referencing Slack, automations, and the API as alternative entry points.

api/introduction.mdx

  • Gap: No base URL, no example of how to attach the auth header to a request.
  • Fix: Added a "Base URL" callout and a "Making a request" section with a curl example using Authorization: Bearer and a note about which key type to use with which endpoints.

deploy/authentication-setup.mdx

  • Gap: No upfront decision aid for choosing between Password, Private, OAuth, and JWT.
  • Fix: Added a "Choose an authentication method" comparison table before the configuration steps, covering best use case, plan, group-based access, API playground pre-fill, and personalization.

deploy/export.mdx

  • Gap: Page didn't explain that the exported zip is fully unauthenticated once distributed and how --groups interacts with that.
  • Fix: Added a "Security considerations" subsection clarifying that the archive is a static bundle, that --groups only controls what's included at export time, and that recipients need a fresh archive to see updates.

deploy/preview-deployments.mdx

  • Gap: Readers could plausibly expect to configure the preview URL or use a custom domain.
  • Fix: Added a sentence clarifying that preview URLs are Mintlify-generated and not configurable, and that custom domains are reserved for production.

Context

Triggered by the scheduled documentation quality workflow. Validation and broken-link checks pass.


Note

Low Risk
MDX documentation and translations only; no application or infrastructure code changes.

Overview
Documentation updates fill common reader questions across authentication, offline export, preview deployments, and localized API intro pages (es/fr/zh).

Authentication setup adds a Choose an authentication method comparison table (plan, groups, playground pre-fill, personalization) before the configuration tabs, mirrored in es/fr/zh.

Offline export adds Security considerations: exported zips are static and unauthenticated; --groups only affects what is baked in at export time; guidance on sharing and redistributing fresh archives.

Preview deployments clarifies that preview URLs are Mintlify-generated and not configurable, and that custom domains apply only to production.

API introduction (locales) tightens the base URL wording and drops the note that each endpoint page lists the full path and HTTP method.

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

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Want reviews to match your repository better? Bugbot Learning can learn team-specific rules from PR activity. A team admin can enable Learning in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 87f452b. Configure here.

Comment thread api/introduction.mdx Outdated
@mintlify

mintlify Bot commented Jul 7, 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 Jul 7, 2026, 10:20 AM

@mintlify

mintlify Bot commented Jul 7, 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 Jul 7, 2026, 10:44 AM

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

Comment thread deploy/preview-deployments.mdx Outdated
Comment thread deploy/export.mdx Outdated
Comment thread deploy/export.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Comment thread deploy/authentication-setup.mdx Outdated
Comment thread deploy/authentication-setup.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Comment thread api/introduction.mdx Outdated
Comment thread agent/index.mdx Outdated
Comment thread es/agent/index.mdx Outdated
Comment thread es/api/introduction.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Comment thread fr/agent/index.mdx Outdated
Comment thread fr/api/introduction.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
Comment thread zh/agent/index.mdx Outdated
Comment thread zh/api/introduction.mdx Outdated
Co-authored-by: Ethan Palm <56270045+ethanpalm@users.noreply.github.com>
@ethanpalm ethanpalm merged commit 6407b43 into main Jul 7, 2026
4 checks passed
@ethanpalm ethanpalm deleted the mintlify/c1f26e90 branch July 7, 2026 20:18
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.

2 participants