Skip to content

Documentation quality check: fill reader-question gaps on 3 pages#6603

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

Documentation quality check: fill reader-question gaps on 3 pages#6603
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/d7deecde

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Fill reader-question gaps identified during a quality review of English MDX pages updated in the last 24 hours.

Changes

automations/reference.mdx

  • Gap: The "At a glance" table uses "Pull request" and "Direct merge" without defining them on the page.
  • Fix: Added a short definition of both update modes under the intro and linked "trigger" and "update mode" to their sections on /automations/manage.

optimize/feedback.mdx

  • Gap: No guidance on exporting or downloading feedback data, even though CSV export exists on the analytics page.
  • Fix: Added an "Export feedback" section that cross-links to Export analytics on /optimize/analytics and to the analytics feedback API endpoint.

organize/related-pages.mdx

  • Gap: No troubleshooting guidance for the common case where the Related topics section doesn't appear on a page.
  • Fix: Added a "Troubleshooting" section covering the most common causes: add-on disabled, related: false, Manual mode without related, end-user–authenticated deployments, and missing page title.

Context

Other reviewed pages (agent/index.mdx, agent/slack.mdx, assistant/customize.mdx, automations/index.mdx, automations/integrations.mdx, components/icons.mdx, customize/custom-scripts.mdx, optimize/analytics.mdx, optimize/seo.mdx, organize/pages.mdx) were assessed but not modified — remaining gaps required facts not verifiable from the source (pricing, permission roles, refresh cadence, notification behavior).


Note

Low Risk
Documentation-only MDX edits with internal links; no application or API behavior changes.

Overview
Closes common reader gaps on three topics, with the same additions mirrored in es, fr, and zh.

On automations/reference, the intro now links trigger and update mode to /automations/manage and briefly defines Pull request vs Direct merge before the summary table.

On optimize/feedback, a new Export feedback section points to analytics Export to CSV, the export-analytics flow, and the analytics feedback API.

On organize/related-pages, a new Troubleshooting section lists why Related topics may be missing (add-on off, related: false, Manual mode without entries, end-user auth, missing title in Automatic mode).

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

@mintlify

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

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 16, 2026, 10:12 AM

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

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🟡 Building Jul 16, 2026, 10:09 AM

@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Jul 16, 2026, 10:09 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