Boatstack documentation is divided by authority and rate of change. Current executable code is the first source of truth, followed by deterministic tests, generated artifacts, exact reference documents, and historical records.
| Plane | Purpose | Start here |
|---|---|---|
| Concepts | Stable terms, relationships, and invariants | Concepts |
| Current architecture | How those concepts map to the implementation now | Architecture |
| Domain guides | Software-delivery behavior and Flow authoring | Product Delivery |
| Reference | Exact commands, schemas, paths, and configuration | Getting started |
| Generated and historical | Machine-owned evidence and superseded design context | Generated files, History |
The glossary is the terminology authority. The TypeScript guide connects authoring APIs to the same Control Program model.
- Getting started
- Configuration
- Control Program IR
- Generated files and ownership
- Runtime selection
- Safety boundaries
- Troubleshooting
- Public-surface contract
The transition catalog, Mermaid graphs, and Locus inputs under
docs/architecture/boatstack-* are produced from executable registries. Their
generators, commands, and verifiers are listed in
Generated files and ownership. Do not edit them by hand.
Boundary: executable behavior becomes a public documentation claim.
Control law: a current claim must be supported by current code, tests, generated evidence, or an exact reference contract; generated evidence remains generator-owned and historical prose cannot become current authority.
Required evidence: resolving links, deterministic documentation contracts, TypeDoc with strict validation, generated-artifact comparison, and relevant runtime tests. A failed check blocks publication rather than weakening the claim or changing runtime behavior to match old prose.