Mintlify CLI for `platform-documentation`

This repo is a Mintlify documentation site (docs.json, MDX under documentation/, api-reference/, SDK folders, etc.). Use the Mintlify CLI from the repository root. Official command reference: Mintlify CLI commands.

When to use this skill

After editing many MDX files, docs.json navigation, or OpenAPI-backed pages.
Before merging changes that affect links, headings (anchor targets), or API reference generation.
When the user asks to validate, check links, preview locally, or run Mintlify.

NOTE: Do not touch these files even if something is wrong:

@release-notes.mdx, @release-notes-rss-feed.mdx, @announcements.mdx

Install and location

Install and update the CLI per Mintlify’s docs (mint update, mint version). Always cd to the repo root (where docs.json and package.json live) before running commands below.

Commands that match this repo

Local preview

mint dev

Same idea as mintlify dev if your environment uses that name. Useful flags (see Mintlify docs): --port (default 3000), --no-open, --groups, --disable-openapi (faster when you do not need OpenAPI processing), --local-schema (local OpenAPI over HTTP). For custom layout, tabs, carousels, or scripts affecting #content-area, confirm in a real browser. Mintlify’s article column is often narrower than the full window width.

Strict validation (includes OpenAPI)

mint validate

Exits with an error if there are warnings or errors; validates OpenAPI specs referenced from docs.json. Use --disable-openapi only when you intentionally skip OpenAPI (for example speed). The standalone mint openapi-check command is deprecated in favor of mint validate.

Broken links

mint broken-links

For this repo, consider:

--check-anchors when you add or rename headings and use #section links.
--check-external for outbound URL checks (slower, network).
--check-redirects for docs.json redirect targets.
--check-snippets if you use <Snippet> with links inside.

Respects .mintignore patterns; ignored targets may report as broken.

Accessibility

mint a11y

Checks contrast and missing alt text on images and videos. Optional: --skip-contrast, --skip-alt-text when narrowing failures.

npm scripts (not Mintlify)

From repository package.json:

Script	When
`npm run build:glossary-index`	After Glossary letter pages or `scripts/build-glossary-index.mjs` changes
`npm run sync:release-notes-versions`	Changelog version pills; also runs via lint-staged when relevant files are staged

Suggested workflow after substantive doc edits

mint validate
mint broken-links --check-anchors (add other flags as needed)
mint dev for anything visual or interactive

See root AGENTS.md for Playwright E2E living in a separate repo, PDF/export scripts, and product-specific doc boundaries (Headless vs Dictation, etc.).

Documentation Index

​Mintlify CLI for platform-documentation

​When to use this skill

​Install and location

​Commands that match this repo

​Local preview

​Strict validation (includes OpenAPI)

​Broken links

​Accessibility

​npm scripts (not Mintlify)

​Suggested workflow after substantive doc edits

​Related repo guidance