Skip to content

Peakberg Documentation

This site is generated directly from markdown in this repository so docs are versioned with code and reviewed in PRs.

Available docs

Operational runbooks

Docs workflow

  1. Edit markdown under /docs.
  2. Run local docs preview.
  3. Open a PR with code + docs updates together.
  4. Deploy docs site from docs:build output.

Local commands

bash
npm run docs:dev
npm run docs:build
npm run docs:preview

Canonical source

Keep markdown in git as the canonical source. If needed, export markdown to other formats (PDF/Google Docs) from this source.