Skip to content

Contributing documentation

The repository's contribution policy is maintained in the root CONTRIBUTING.md file. Read that file before opening a change; it contains the crate boundaries, required Rust checks, security-sensitive areas, Freebird compatibility guidance, and documentation expectations.

Documentation changes

Use the root policy for contribution workflow and validation. In particular, keep public behavior documented in the appropriate user, production, security, release, or changelog document. Keep claims about privacy, trust, and supported operations consistent with the threat model.

The documentation in this directory is grouped as follows:

  • Guides describe supported user and operator workflows.
  • Prior art gives cautious context about adjacent systems.
  • Roadmap records TODO items for maintainer review; it is not a promise of delivery.

The root CONTRIBUTING.md remains authoritative if this page and it ever disagree.