Documentation Policy
This page explains where to document behavior vs rationale in the Bowerbird repo.
Canonical source
Section titled “Canonical source”- User-facing CLI behavior is canonical in docs-site (
docs-site/src/content/docs/) and published athttps://bwrb.dev. - Product rationale and internal design notes live in
docs/product/.
Practical rule
Section titled “Practical rule”- Behavior contracts: document in docs-site.
- Internal rationale: document in
docs/product/and link to docs-site for behavior details. - Prefer summary + link over duplicating full behavior specs.
For the full policy, see docs/product/canonical-docs-policy.md.