Skip to content

Latest commit

 

History

History
39 lines (27 loc) · 1.46 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.46 KB

Developer documentation

This directory contains repository-only documentation for people changing, validating, and releasing daml-tools itself. It is intentionally outside the VitePress docs/ tree so these maintainer runbooks are not published on the consumer documentation site.

Published consumer documentation remains in docs/ and on GitHub Pages.

Repository runbooks

Use these when you are working on the repo rather than consuming the published packages:

Published docs source

The VitePress site lives in docs/:

Local preview from the repository root:

npm ci --prefix docs
npm run dev --prefix docs

npm audit --prefix docs may report known transitive advisories while the site build still passes; see the Tier 4 notes in CONTRIBUTING.md.

Rust API documentation remains on docs.rs. Crate READMEs stay the crates.io, docs.rs, and GitHub package entry points.