3.6 KiB
Archipelago documentation
Start with the smallest set for your task. This index distinguishes current
entry points from proposals and dated evidence. Code and the root
AGENTS.md govern actual behavior and authority; a dated plan,
passing test or historical node receipt does not certify a newer build.
New developer path
- Project README — what ships and which installer and update releases are published.
- Contribution guide and developer guide — canonical ngit workflow, source map and safe local checks.
- OS architecture (visual HTML guide) — browser, backend, rootless apps, data, trust and protected host maintenance.
- Release & Testing — current scope, evidence levels and open acceptance gates.
Work by area
| Area | Read first | Then, if relevant |
|---|---|---|
| Backend/API | Developer guide | RPC overview, container lifecycle |
| Frontend | Developer guide | Gamepad navigation, TV input |
| App packaging | App developer guide | Manifest spec, Quadlet compilation, app secrets, catalog distribution |
| Installer and updates | Image recipe | OS updates, protected executor contract, system-level OTA design |
| Network and fleet | Multi-node architecture | Peering trust, external access and websites, OpenWrt setup |
| Security | Security policy | 2.1 beta audit matrix, Bitcoin RPC exposure, PSBT signing |
| Release operations | Release & Testing | Candidate catalog qualification, target-specific OS manifests |
The API overview is hand-maintained. Verify exact method behavior in
core/archipelago/src/api/rpc/ and its tests. App and OS changes require their
separate acceptance contracts; do not treat a generic build or UI mock as an
installed-node pass.
Users and operators
- User walkthrough and troubleshooting.
- Seed verification and talking to your node.
- Pine voice commands and Companion pairing QR.
Dated designs and evidence
The public roadmap records direction, not an active release
checklist. TODO.md holds unscoped follow-ups; the current
release plan and failure gates are in Release & Testing.
Other design documents in docs/ describe proposed or historical behavior.
Read their date and status before using them. The adr/ directory
records design decisions; archive/ and Git history retain
superseded material. Dated release acceptance and incident records remain
version-specific evidence, not instructions to rerun their old actions. Old
deployment runbooks and completed checklists removed from the active tree are
available in Git history.