Beacon documentation
Use this index to choose Beacon documentation by task. It follows Diátaxis so operational instructions, exact contracts, and architectural reasoning remain distinct; update the canonical page instead of duplicating content elsewhere.
Tutorials
Use tutorials to get a working local instance through a prescribed sequence.
- Tutorial index — guided paths with a known starting state.
How-to guides
Use how-to guidance when operating a known Beacon deployment or completing a focused operational task.
- How-to index — focused operational procedures with recovery guidance.
Reference
Use reference pages for exact names, inputs, outputs, defaults, and failure behavior.
- Reference index — exact API and configuration contracts. Deployment values are supplied by the operator; Beacon does not discover or infer them.
Explanation
Use explanations to understand why Beacon has its boundaries and tradeoffs before changing its architecture or contracts.
- Explanation index — system boundaries and design tradeoffs.
Release information
Use the current release description when preparing an annotated v0.1.0 tag or assessing release-facing behavior and known limits.
License
Beacon is available under the Apache License, Version 2.0.