Skip to main content
The docs live in apps/docs and are hosted by Mintlify.

​
Write

Edit the .mdx pages. Keep introductions short, lead with a working example, and put detailed behavior in Reference or an accordion. Add new pages to docs.json. The MCP, configuration, and HTML references are generated by scripts/generate.ts. Edit the generator or application source, then regenerate. Keep generated snapshots in Git so Mintlify can build them independently.

​
Validate

The build validates MDX, navigation, links, JSON examples, and source references. It creates a docs-only deployment directory at apps/docs/dist. Run task check:fix and bun run package for repository changes. Use manual browser checks; do not run automated tests.

​
Publish

Publish the prepared directory to Mintlify. For a direct Git connection, set the documentation directory to /apps/docs and regenerate references before committing. Mintlify provides search, page Markdown, llms.txt, and llms-full.txt. Keep docs and runtime releases aligned. Build metadata identifies the source snapshot; the deployed server’s tool schemas remain authoritative. The application redirects /docs to the hosted documentation. It does not bundle or run Mintlify. Custom-domain and repository settings are managed in the Mintlify dashboard.