docs(README): index the contributor docs the launch reader needs
The index covered users, architecture and app development but had no entry point for "I want to work on Archipelago itself" — so eight tracked docs were reachable only by guessing filenames, including the two that matter most to a newcomer: developer-guide.md (how to build the workspace, the frontend and an ISO) and LICENSE-COMPLIANCE-AUDIT.md (dependency licensing, which is exactly what a reader checks first on an open-source repo). Added a "Contributing to Archipelago itself" section covering those plus bulletproof-containers, the signing runbook, the 1.8.0 hardening plan and CLAUDE.md; filed pine-voice-commands under Getting started and demo-build-info under contributing. Also noted that ADR-010 was never issued — verified across all history, so the 009 → 011 gap is not a missing file — and added the two archived session logs (HANDOVER-2026-07-02, SESSION-1.8.0-OTA-PROGRESS) to the archive table, which already claimed to cover completed session logs but listed none. Link check re-run across docs/: 0 broken. Only RELEASE_NOTES_BACKLOG.md is now deliberately unindexed (internal working list). Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5
parent
a28b3b696d
commit
69f1d18ee7
@@ -11,6 +11,7 @@ disagree, the code wins and the doc is a bug.
|
||||
- [Seed Verification](SEED-VERIFICATION.md) — independently verify your 24-word backup
|
||||
- [Troubleshooting](troubleshooting.md) — common problems and how to resolve them
|
||||
- [Gamepad / Controller Navigation](GAMEPAD-NAV.md) — driving the UI from a controller
|
||||
- [Pine voice commands](pine-voice-commands.md) — the voice-satellite phrase surface
|
||||
|
||||
## Architecture
|
||||
|
||||
@@ -18,6 +19,16 @@ disagree, the code wins and the doc is a bug.
|
||||
- [Multi-Node Architecture](multi-node-architecture.md) — how nodes relate across a fleet
|
||||
- [API Reference](api-reference.md) — the JSON-RPC surface
|
||||
|
||||
## Contributing to Archipelago itself
|
||||
|
||||
- [Developer Guide](developer-guide.md) — building the workspace, the frontend, and an ISO
|
||||
- [Contributor guide (`CLAUDE.md`)](../CLAUDE.md) — invariants, build/verify, the production test gate
|
||||
- [Bulletproof containers](bulletproof-containers.md) — why the reconciler is level-triggered
|
||||
- [Release signing runbook](workstream-b-signing-runbook.md) — the ceremony and key handling
|
||||
- [1.8.0 Release Hardening Plan](1.8.0-RELEASE-HARDENING-PLAN.md) — the release-blocking checklist
|
||||
- [Third-party license audit](LICENSE-COMPLIANCE-AUDIT.md) — dependency licensing posture
|
||||
- [Demo build info](demo-build-info.md) — operating the public demo sandbox
|
||||
|
||||
## App development
|
||||
|
||||
- [App Developer Guide](app-developer-guide.md) — build and package a containerized app
|
||||
@@ -62,6 +73,9 @@ step-by-step guides, and some predate the current implementation.
|
||||
- [ADR-009: Manifest-Level Container Security](adr/009-manifest-container-security.md)
|
||||
- [ADR-011: DWN Deprioritization](adr/011-dwn-deprioritization.md)
|
||||
|
||||
There is no ADR-010 — the number was never issued, so the gap is not a missing
|
||||
file.
|
||||
|
||||
## Security
|
||||
|
||||
- [Security Policy](../SECURITY.md) — how to report a vulnerability
|
||||
|
||||
@@ -20,3 +20,5 @@ For current state, start at:
|
||||
| `lora-functionality.html` | Generated LoRa/mesh guide (2026-04) | Predates X3DH/double-ratchet, Reticulum transport, and mesh AI |
|
||||
| `INSTALL-SCREENS-DESIGN.md` | Installer screen design solicitation | Installer implemented in `image-recipe/` |
|
||||
| `three-mode-ui-design.md` | Design for the Pro/Easy/Chat three-mode UI | Fully implemented (`stores/uiMode.ts`, `EasyHome.vue`, `Chat.vue`, goals system) |
|
||||
| `HANDOVER-2026-07-02-iso-feedback.md` | Session handover from the 2026-07-02 ISO feedback bug-bash | Completed session log |
|
||||
| `SESSION-1.8.0-OTA-PROGRESS.md` | Working notes from the 1.8.0 OTA push | Completed session log |
|
||||
|
||||
Reference in New Issue
Block a user