The documentation tree contains maintained guidance, public contracts, generated baselines, and historical release records. Use this page to choose the current source of truth instead of relying on similarly named historical documents.
- Getting started: install, build, run, and validate the project.
- Workspace and package guide: active crates, binaries, embedded surfaces, and dependency boundaries.
- Current roadmap: repository-wide parity posture, release confidence, evidence boundaries, and execution order.
- SDK integration guide: supported application integration path.
- MeshChat Rust POC runbook: opt-in local API, supported chat flows, and current test limits.
- MeshChat 2.4.0 source contract: pinned HTTP and WebSocket reference specification for the POC.
- Checked examples: daemon, SDK, transport, and validation examples.
Update these documents when their corresponding behavior changes:
- Current roadmap: repository-level status and execution order.
- Reticulum parity matrix: maintained Reticulum row-level parity status.
- LXMF parity matrix: maintained LXMF row-level parity status.
- Software parity ledger: implementation work packets and evidence ownership.
- Independent interoperability evidence: versioned rns-rs and Reticulum-Go evidence.
- Performance report: current methodology and generated results.
- v0.9.9 release notes: historical stable release summary. The historical rc.6 evidence remains in the candidate ledger.
- v0.10.0 release notes: current RNS 1.5.0 stable release summary, with immutable-tag evidence tracked in its release ledger. The superseded rc.1 record remains in the historical candidate ledger.
- v0.10.1 release notes: RNS 1.5.2 maintenance candidate, with qualification tracked in the candidate ledger and the reserved stable ledger.
- v0.11.0 release notes: RNode transport repair and pre-1.0 compatibility boundary.
- v0.12.0 release notes: scoped Reticulum 1.5.4-dev feature update and qualified parity boundary.
- v0.12.0 candidate ledger: local release evidence and exact-head publication conditions.
- Contracts: public compatibility, support, API, payload, RPC, and protocol guarantees.
- Interfaces: interface-specific configuration and integration guidance.
- Runbooks: operator, verification, and release procedures.
- Architecture: active architecture policy and governance.
- Architecture decisions: rationale for major design directions.
- SDK guide
- SDK quickstart
- API surface and stability
- CLI quick reference
lxmdsystemd deploymentreticulumdoperational deployment- Logging and diagnostics
- SDK configuration cookbook
- Meshtastic tunnel interface
- RNode Bluetooth Classic/SPP interface
- Architecture overview
- JSON and wire-field mapping
- Compatibility contract
- Compatibility matrix
- Third-party compatibility kit
- Support and LTS policy
- Extension registry
- RPC contract
- Payload contract
The following directories contain documentation-shaped files that are consumed by tests, code generation, or CI. Treat changes to them with the same care as source changes:
Migration guides are retained for users crossing public API or architecture boundaries. Superseded release-candidate notes and evidence ledgers are historical records; they do not override the current roadmap or stable release notes. Completed implementation plans and issue boards belong in Git history instead of the live documentation tree.
- Prefer one maintained document over several overlapping notes.
- When adding a canonical document, remove or clearly mark the superseded one in the same change.
- Keep file paths portable; do not commit machine-local absolute paths.
- Link broad entry points to current sources of truth so historical notes do not become the default.
- Before deleting documentation, search code, workflows,
xtask, and other docs for consumers.