Skip to main content

Run locally

npm i -g mint
mint dev
Mintlify preview starts on http://localhost:3000 by default.
mint broken-links

Docs repo workflow

  1. Make MDX changes.
  2. Run local preview.
  3. Run broken link checks.
  4. Commit and push.

Content standards

  • Prefer user-facing, actionable language.
  • Keep code examples copy-pasteable.
  • Keep Python and Node.js examples aligned where behavior is equivalent.
  • When behavior changes, update SDK docs and platform docs together.