Mintlify Starter Kit

Use the starter kit to get your docs deployed and ready to customize.

Click the green Use this template button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with

• Guide pages
• Navigation
• Customizations
• API reference pages
• Use of popular components

Follow the full quickstart guide

AI-assisted writing

Set up your AI coding tool to work with Mintlify:

npx skills add https://mintlify.com/docs

This command installs Mintlify's documentation skill for your configured AI tools like Claude Code, Cursor, Windsurf, and others. The skill includes component reference, writing standards, and workflow guidance.

See the AI tools guides for tool-specific setup.

Development

Install the Mintlify CLI to preview your documentation changes locally. To install, use the following command:

npm i -g mint

Run the following command at the root of your documentation, where your docs.json is located:

mint dev

View your local preview at http://localhost:3000.

Publishing changes

Install our GitHub app from your dashboard to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch.

OpenAPI spec sync

The Fluid backend publishes generated OpenAPI specs to a public GCS mirror. The OpenAPI sync workflow pulls those specs into this repository every hour. You can also run the workflow manually. Mintlify generates the endpoint reference pages from the committed specs.

Use .github/synced-specs.json to add or remove a synced spec. Each entry maps a GCS URL to a file under api-reference/. Do not edit the synced files under api-reference/ directly.

The workflow runs mint validate before publishing a change. It commits valid specs to main and quarantines invalid specs on the spec-sync-blocked branch. After a successful sync, the guide-claims checker reports contradictions between the generated reference and hand-written guides in a guide-spec-conflict issue.

Read the guide truth runbook before changing the sync configuration or resolving a validation or guide-claim conflict.

Need help?

Troubleshooting

• If your dev environment isn't running: Run mint update to ensure you have the most recent version of the CLI.
• If a page loads as a 404: Make sure you are running in a folder with a valid docs.json.

Resources

• Mintlify documentation