Skip to content

Documentation quality check: fix gaps in recently updated pages - #7168

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

Documentation quality check: fix gaps in recently updated pages#7168
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/f9d2291f

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

Quality evaluation of the 15 English MDX pages updated in the last 24 hours found real gaps on 4 pages; all are fixed here and mirrored into es, fr, and zh translations.

Changes

  • guides/use-automations.mdx (+ es/fr/zh)
    • Gap: page claimed "three trigger types," contradicting automations/index.mdx and automations/manage.mdx, which document four (including Integration). Readers choosing a trigger from this guide would never learn Integration triggers exist.
    • Fix: corrected to four and added an Integration row to the trigger table.
  • integrations/analytics/google-tag-manager.mdx (+ es/fr/zh)
    • Gap: page never said where the tag ID comes from or how to verify the container loads (the sibling GA4 page covers both).
    • Fix: added one sentence identifying the tag ID as the GTM container ID and a verification note pointing to GTM preview mode.
  • deploy/cloudflare.mdx (+ es/fr/zh)
    • Gap: the "Example working configuration" firewall rule (merged from the deleted troubleshooting page) still referenced a real customer domain, docs.flashnet.xyz.
    • Fix: genericized to docs.yourdomain.com.
  • migration-services/go-live-checklist.mdx (+ es/fr/zh)
    • Gap: the new "upload the zip" step didn't say where the zip comes from or whether to commit it or extract it.
    • Fix: linked to the migration services page and clarified to extract the zip and add the files.

Maintenance pass

  • Translations: all 4 English edits mirrored into the 12 existing es/fr/zh counterpart files, preserving markup and locale-prefixed internal links.
  • Broken links: mint broken-links passes; no broken links introduced or found in touched files.
  • SEO metadata: titles and descriptions on all 4 pages are present, unique, and within length limits; no changes needed.
  • Grammar/style: no typos or style deviations found in the changed files.

Gaps deliberately left unfixed

  • api/static-export/start-job.mdx: the server accepts an optional basePath body field that isn't in static-export-openapi.json. The endpoint is in private beta, so the omission may be intentional; not adding without confirmation.
  • migration-services/enterprise.mdx: uses the same ambiguous "add the zip" wording, but it was outside this run's changed-file scope.

Pages evaluated with no gaps: automations create/manage/reference, api/automations/trigger, static-export overview and get-job-status, dashboard/roles, ai/llmstxt, editor/index, deploy/vercel.


Note

Low Risk
MDX documentation and localization only; no application code, APIs, or security behavior changes.

Overview
Documentation quality fixes across English and localized (es, fr, zh) MDX for four topics identified in a recent content review.

Automations guide — Updates the trigger section from three to four types and adds an Integration table row (Slack / connected tools, custom automations), aligning with the automations product docs.

Google Tag Manager — Adds where the tag ID comes from (GTM-XXXXXXX container ID) and a post-publish check using GTM preview mode.

Cloudflare deploy — Replaces a real customer hostname (docs.flashnet.xyz) with docs.yourdomain.com in the example WAF rule snippet.

Go-live checklist — Clarifies migration onboarding: link to enterprise migration services, extract Mintlify’s delivered zip, and add the files to the repo (instead of ambiguous “upload the zip”).

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

@mintlify

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

@mintlify

mintlify Bot commented Aug 28, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟡 Building Aug 28, 2026, 10:12 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.

0 participants