Documentation

Verification

Which commands prove package, docs, and site changes.

Use the narrowest command that proves your change while iterating, then run the broader gate before considering the work complete.

npm run --workspace @plumile/router test:build-package
npm run docs:lint
npm run docs:build
npm run docs:site:check
npm run docs:site:build
npm run docs:all
npm run check

Public API changes require tests and docs updates in the same change.

Netlify builds the public documentation site with npm run docs:all and publishes website/public.

For local documentation work, the Justfile exposes shorter commands:

just website-check
just website-build-local
just docs-build
just docs-clean