Documentation quality check: fill gaps in recently updated pages#6547
Open
mintlify[bot] wants to merge 2 commits into
Open
Documentation quality check: fill gaps in recently updated pages#6547mintlify[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
1 participant
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
Ran a two-phase Diataxis-based quality review on English MDX files updated in the last 24 hours and added content to close the gaps a reader would reasonably expect each page to cover.
Changes
ai/skillmd.mdxskill.mdbefore it goes live.mint devlocal preview, post-deploy verification against/skill.mdand/.well-known/agent-skills/index.json, and cross-referencing the agentskills specification.api-playground/troubleshooting.mdxapi.playground.proxyoverrides), how to identify them in the browser console, and the response headers a backend needs to return.editor/drafts.mdxintegrations/analytics/overview.mdxmigration-services/go-live-checklist.mdxmint broken-links, and API playground requests.Pages evaluated with no gaps found:
ai-native.mdx,ai/model-context-protocol.mdx,api/static-export/overview.mdx,components/cards.mdx,contact-support.mdx,dashboard/sso.mdx,deploy/github.mdx,deploy/multi-repo.mdx,editor/branching-and-publishing.mdx,editor/index.mdx,editor/settings.mdx,optimize/seo.mdx.Note
Low Risk
MDX documentation and translations only; no application code, config schema, or runtime behavior changes.
Overview
Adds reader-facing sections that were missing from recently updated docs, with matching updates in es, fr, and zh where those pages exist.
skill.md— New Validate a custom skill file guidance: frontmatter checks, local preview viamint devand/skill.md, post-deploy checks against discovery manifests, and agentskills.io alignment; notes that custom skills ship on deploy faster than auto-generated skills.API playground troubleshooting — New accordion for CORS errors when playground traffic bypasses Mintlify’s
/_mintlify/api/requestproxy (api.playground.proxy), including required headers,OPTIONSpreflight, and falling back to the default proxy.Editor drafts — New Preview a draft section: per-draft preview deployments, copying the URL from the publish menu, auto-refresh on save, and optional preview authentication via Add-ons.
Analytics overview — New Verify your setup after
docs.jsondeploy: trigger tracked events on production, provider realtime views (GA4, PostHog, Mixpanel, Amplitude), and ad-blocker caveats.Go-live checklist — New Post-launch verification (and full localized checklist pages where added): SSL/pages, nav/search, redirects, auth, analytics,
mint broken-links, and API playground without CORS.Reviewed by Cursor Bugbot for commit 8e7a535. Bugbot is set up for automated code reviews on this repo. Configure here.