Documentation for Checkly, built with Mintlify.
The Mintlify CLI is installed as a devDependency so you can preview documentation changes locally.
Run the following command at the root of the docs (where docs.json lives):
npm run dev
Add content directly in .mdx files with MDX syntax and React components. The Mintlify component reference is the best place to look up what's available:
See CLAUDE.md for project-specific writing conventions (frontmatter, voice, component usage rules).
The Mintlify GitHub app auto-propagates changes from this repo to the live docs. Changes pushed to main deploy to production automatically.
- Dev environment isn't running: run
mint updateto ensure you have the most recent version of the CLI. - Page loads as a 404: make sure you're running in a folder with
docs.json.