Docs that map the app, CLI, and extension as one system.

This repository contains both the CLI source and the docs source.

Build and test the CLI

npm install
npm run build
npm run check
npm test

Preview the docs locally

The repo ships a docs.json config and MDX pages at the repository root. For local authoring preview, use:

npm run docs:dev

That runs the local docs preview via the repo-pinned mint binary.

Build the deployable docs site

The public docs deployment is generated as a static site. Build it with:

npm run build:docs:site

That writes the deployable output into ./public, including:

• clean HTML routes such as /platform/cli
• Markdown exports such as /platform/cli.md
• llms.txt
• llms-full.txt

Validate docs quality

Broken links:

npm run docs:broken-links

Accessibility checks:

npm run docs:a11y

If the docs commands fail because dependencies are missing, run npm install again. The local preview tooling is pinned as a dev dependency for reproducible docs workflows.

Editing guidance

• keep the docs aligned with the actual CLI command surface in src/cli.ts
• document app and extension behavior as contracts when the code is outside this repo
• prefer command examples that produce real artifacts in ./data
• keep fallback behavior clearly labeled as fallback
• update docs.json whenever you add or rename a page

High-value files

• docs.json
• index.mdx
• platform/*
• workflows/*
• integrations/*
• reference/*
• operations/*

Release mindset

When you change command names, field shapes, or auth behavior, update:

• the implementation
• the tests
• these docs

This repository is small enough that letting docs drift is a choice, not an inevitability.