Development

Work on the CLI and Mintlify docs locally.

Project Commands

Install dependencies:

pnpm install

Build the CLI:

pnpm build

Run the test suite:

pnpm test

Run static checks:

pnpm lint
pnpm typecheck

Mintlify Docs Commands

Preview the docs locally:

pnpm docs:dev

Validate the Mintlify config and content:

pnpm docs:validate

Check for broken links:

pnpm docs:broken-links

Docs Layout

The Mintlify site is configured by docs.json inside the docs/ directory.

Documentation pages live in:

• index.mdx
• getting-started/
• configuration/
• commands/
• reference/

Mintlify Project Settings

If this repository is connected to Mintlify, configure it as a monorepo project and set the docs path to /docs.

Mintlify expects a valid docs.json inside that configured docs directory.

Repo Hygiene

This repository contains product source and docs in the same root.

.mintignore excludes non-documentation files and directories from the published docs site, including:

• CLI source code
• Tests
• Build output
• Local webhook storage
• Internal planning notes

Editing Guidance

When updating the docs:

1. Keep command examples aligned with src/cli.ts.
2. Keep config examples aligned with src/types.ts and src/config.ts.
3. Validate docs changes before publishing.
4. Prefer documenting actual runtime behavior over aspirational behavior.