About the reference
The reference section is the exact, terse layer under the rest of this site: what every command does, what every word means, and where the design decisions are written down.
- Glossary: the project’s vocabulary, one paragraph each.
- rrn command reference and station command reference: the built-in help for every command, generated from the code.
- Configuration: every key in
config.tomlwith its default, the environment variables, and the data-directory layout. - Architecture decision records: the locked-decision record, with links.
- Wire specifications: QR payloads, bundles, SMS, the boot ceremony.
What is authoritative
This site explains. The station repo decides. In order of authority:
- The ADRs in
station/docs/adr/. Append-only; a changed decision gets a new ADR that supersedes the old one. - The wire specs in
station/docs/spec/. - The design overview in
station/docs/design/, which predates parts of the implementation and says so where it conflicts with an ADR. - This site.
If a page here disagrees with an ADR, the page has a bug. Tell us.