Documentation quality check: fix gaps in recently updated pages - #7168
Open
mintlify[bot] wants to merge 2 commits into
Open
Documentation quality check: fix gaps in recently updated pages#7168mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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)automations/index.mdxandautomations/manage.mdx, which document four (including Integration). Readers choosing a trigger from this guide would never learn Integration triggers exist.integrations/analytics/google-tag-manager.mdx(+ es/fr/zh)deploy/cloudflare.mdx(+ es/fr/zh)docs.flashnet.xyz.docs.yourdomain.com.migration-services/go-live-checklist.mdx(+ es/fr/zh)Maintenance pass
mint broken-linkspasses; no broken links introduced or found in touched files.Gaps deliberately left unfixed
api/static-export/start-job.mdx: the server accepts an optionalbasePathbody field that isn't instatic-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-XXXXXXXcontainer ID) and a post-publish check using GTM preview mode.Cloudflare deploy — Replaces a real customer hostname (
docs.flashnet.xyz) withdocs.yourdomain.comin 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.