Skip to content

README.md

Latest commit

 

History

History
33 lines (20 loc) · 1.2 KB

README.md

File metadata and controls

33 lines (20 loc) · 1.2 KB

Checkly docs

Documentation for Checkly, built with Mintlify.

Development

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

Editing content

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).

Publishing changes

The Mintlify GitHub app auto-propagates changes from this repo to the live docs. Changes pushed to main deploy to production automatically.

Troubleshooting

  • Dev environment isn't running: run mint update to 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.