From 9221d1bfaf68aa3779d2aa539096b5d4e8616ca5 Mon Sep 17 00:00:00 2001 From: archipelago Date: Wed, 8 Jul 2026 17:04:35 -0400 Subject: [PATCH] docs: move 10 finished/historical docs into docs/archive/ with an index MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Session logs, handovers, point-in-time snapshots, the v0.1.0 security audit, stale generated HTML guides, and shipped design docs (three-mode UI, install screens) move out of the living docs/ tree. docs/archive/README.md explains what each was and why it's archived; all in-repo links updated. (docs/UNIFIED-TASK-TRACKER.md links intentionally untouched — it has another agent's uncommitted work in flight.) Co-Authored-By: Claude Fable 5 --- CLAUDE.md | 2 +- docs/1.8.0-RELEASE-HARDENING-PLAN.md | 2 +- docs/PRODUCTION-MASTER-PLAN.md | 16 ++++++------ docs/RETICULUM-TRANSPORT-PROGRESS.md | 2 +- docs/architecture.md | 6 ++--- .../HANDOVER-2026-07-02-iso-feedback.md | 0 docs/{ => archive}/INSTALL-SCREENS-DESIGN.md | 0 docs/archive/README.md | 26 +++++++++++++++++++ .../SESSION-1.8.0-OTA-PROGRESS.md | 0 .../app-registry-status-2026-06-21.md | 0 docs/{ => archive}/architecture-review.html | 0 docs/{ => archive}/demo-deployment-design.md | 0 docs/{ => archive}/lora-functionality.html | 0 .../rust-orchestrator-migration.md | 0 .../security-code-audit-2026-03.md | 0 docs/{ => archive}/three-mode-ui-design.md | 0 docs/demo-build-info.md | 2 +- 17 files changed, 41 insertions(+), 15 deletions(-) rename docs/{ => archive}/HANDOVER-2026-07-02-iso-feedback.md (100%) rename docs/{ => archive}/INSTALL-SCREENS-DESIGN.md (100%) create mode 100644 docs/archive/README.md rename docs/{ => archive}/SESSION-1.8.0-OTA-PROGRESS.md (100%) rename docs/{ => archive}/app-registry-status-2026-06-21.md (100%) rename docs/{ => archive}/architecture-review.html (100%) rename docs/{ => archive}/demo-deployment-design.md (100%) rename docs/{ => archive}/lora-functionality.html (100%) rename docs/{ => archive}/rust-orchestrator-migration.md (100%) rename docs/{ => archive}/security-code-audit-2026-03.md (100%) rename docs/{ => archive}/three-mode-ui-design.md (100%) diff --git a/CLAUDE.md b/CLAUDE.md index 9de0aeb1..4f3d91ed 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -23,7 +23,7 @@ Detailed sub-plans (all linked from the master): - App platform / packaging phases + security model → `docs/APP-PACKAGING-MIGRATION-PLAN.md` - Registry-distributed manifests (in progress) → `docs/registry-manifest-design.md` - External/decentralized marketplace for devs → `docs/marketplace-protocol.md` -- Current per-app state → `docs/app-registry-status-2026-06-21.md` +- Current per-app state → `docs/archive/app-registry-status-2026-06-21.md` - Production test gate (exit criterion) → `tests/lifecycle/TESTING.md` ## Commit & push every unit of work (never violate) diff --git a/docs/1.8.0-RELEASE-HARDENING-PLAN.md b/docs/1.8.0-RELEASE-HARDENING-PLAN.md index 02ac70ab..13674a18 100644 --- a/docs/1.8.0-RELEASE-HARDENING-PLAN.md +++ b/docs/1.8.0-RELEASE-HARDENING-PLAN.md @@ -273,7 +273,7 @@ media (latest artifact only one minor behind). - [ ] 🟢 **Harden LUKS + roadmap A/B partitioning.** The LUKS data key sits in plaintext on the unencrypted root (`:2137`); add TPM2/passphrase binding. Longer-term: A/B (or factory-reset) partitions for safe OTA rollback, and a real install-time TUI - (`docs/INSTALL-SCREENS-DESIGN.md` exists but the installer is headless "press Enter"). + (`docs/archive/INSTALL-SCREENS-DESIGN.md` exists but the installer is headless "press Enter"). --- diff --git a/docs/PRODUCTION-MASTER-PLAN.md b/docs/PRODUCTION-MASTER-PLAN.md index e894570d..39bc6a2c 100644 --- a/docs/PRODUCTION-MASTER-PLAN.md +++ b/docs/PRODUCTION-MASTER-PLAN.md @@ -54,7 +54,7 @@ real nodes. Until then, this plan is the priority. - **~40 apps are manifest-based and Quadlet-migrated** (survive `archipelago.service` restart + reboot). Exhaustive per-app table: - `docs/app-registry-status-2026-06-21.md`. + `docs/archive/app-registry-status-2026-06-21.md`. - **Legacy holdout: immich** — the one app with **no manifest** and a hardcoded Rust stack installer (in-cgroup, not Quadlet). 3 containers, healthy, live data. The migration proof case. @@ -77,7 +77,7 @@ real nodes. Until then, this plan is the priority. | E | **Production test gate** — 5× lifecycle on **.228**, per-app L1/L2 matrix; multinode is split out → `multinode-testing-plan.md` | `tests/lifecycle/TESTING.md`, `bulletproof-containers.md` | **✅ .228 5×-GREEN (110/110 ×5, 0 not-ok, 2026-06-23)** — but this is DESTRUCTIVE-tier / ~8 core apps only; see §6c for the coverage gaps | | F | **Lifecycle perfection — cascade + progress + ALL apps** — extend the gate to uninstall/reinstall (cascade), real install/uninstall progress UI, and EVERY installed app (not just the 8 core). The "insanely-perfect OS/container environment" bar. | §6c (below), `tests/lifecycle/TESTING.md` | **IN PROGRESS (2026-06-26)** — root bug FIXED: uninstall could hang → ghost/stuck-bar/reinstall-block (`71cc9ac4`, unbounded systemctl/podman in `quadlet::disable_remove`); `cascade-uninstall.bats` **7/7 green on .228** w/ binary `ae349a75`. Remaining: wire CASCADE into the canonical gate run, progress-UI truthfulness, all-apps matrix, guardian/IBD state. | -**Orchestrator architecture** (foundation for A/B): `rust-orchestrator-migration.md` +**Orchestrator architecture** (foundation for A/B): `archive/rust-orchestrator-migration.md` (ProdContainerOrchestrator, BootReconciler 30s level-triggered reconcile, adoption scan, Quadlet rendering) and `bulletproof-containers.md` (the six container failure modes FM1–FM6 + the desired-state-first reconciler that fixes them). @@ -159,7 +159,7 @@ the next release. **Authoritative detail + exact remaining steps + test matrix filebrowser). It explicitly **SKIPS uninstall/reinstall** (the CASCADE tier is gated behind `ARCHY_ALLOW_CASCADE_DESTRUCTIVE`, which `run-gate.sh` never sets) and has **zero coverage** for the other ~30 apps (grafana, jellyfin, vaultwarden, penpot, nextcloud, photoprism, -uptime-kuma, homeassistant, … — see `app-registry-status-2026-06-21.md`). So uninstall, +uptime-kuma, homeassistant, … — see `archive/app-registry-status-2026-06-21.md`). So uninstall, reinstall, install-progress UI, and most apps were never under test. **Real bugs found in manual multinode testing on .198 (2026-06-23) — the motivating evidence:** @@ -313,7 +313,7 @@ phases 2–6 (`dual-ecash-design.md`). **Branch/worktree:** currently on `bitcoin-version-bulletproof`, not `main`. Worktree is dirty. Do **not** discard mesh changes: they include E2E/transport indicator plumbing and the Meshtastic -receive-path fixes below. Separate recovery note: `docs/SESSION-1.8.0-OTA-PROGRESS.md`. +receive-path fixes below. Separate recovery note: `docs/archive/SESSION-1.8.0-OTA-PROGRESS.md`. **What was done this session:** 1. ✅ **Local Rust release gate fixed and green.** `cargo test -p archipelago --bin archipelago` is @@ -902,13 +902,13 @@ This master plan is the hub. Authoritative standalone docs (linked above), kept: - **Design:** `architecture.md`, `app-developer-guide.md`, `APP-PACKAGING-MIGRATION-PLAN.md`, `registry-manifest-design.md`, `marketplace-protocol.md`, `dht-distribution-design.md`, - `multi-node-architecture.md`, `rust-orchestrator-migration.md`, - `bulletproof-containers.md`, `three-mode-ui-design.md`, `dual-ecash-design.md`, + `multi-node-architecture.md`, `archive/rust-orchestrator-migration.md`, + `bulletproof-containers.md`, `archive/three-mode-ui-design.md`, `dual-ecash-design.md`, `meshroller-integration-design.md`, `phase4-streaming-ecash-plan.md`, `adr/*`. - **Reference:** `app-manifest-spec.md`, `api-reference.md`, `developer-guide.md`, `operations-runbook.md`, `troubleshooting.md`, `user-walkthrough.md`, - `bitcoin-rpc-relay.md`, `security-code-audit-2026-03.md`, `GAMEPAD-NAV.md`, - `SEED-VERIFICATION.md`, `hotfix-process.md`, `app-registry-status-2026-06-21.md`. + `bitcoin-rpc-relay.md`, `archive/security-code-audit-2026-03.md`, `GAMEPAD-NAV.md`, + `SEED-VERIFICATION.md`, `hotfix-process.md`, `archive/app-registry-status-2026-06-21.md`. All dated handoffs/resumes/transcripts/superseded trackers were consolidated here and removed (recoverable via git) on 2026-06-21. diff --git a/docs/RETICULUM-TRANSPORT-PROGRESS.md b/docs/RETICULUM-TRANSPORT-PROGRESS.md index 5441c4f8..17401804 100644 --- a/docs/RETICULUM-TRANSPORT-PROGRESS.md +++ b/docs/RETICULUM-TRANSPORT-PROGRESS.md @@ -8,7 +8,7 @@ Full plan: `.claude/plans/enchanted-strolling-rocket.md`. Memory pointer: `project_reticulum_transport_plan.md` (auto-memory index). **Coordination note (2026-06-30):** a separate agent owns concurrent Meshtastic work, scoped to -`mesh/meshtastic.rs` + `mesh/protocol.rs` (see `docs/SESSION-1.8.0-OTA-PROGRESS.md`) and explicitly +`mesh/meshtastic.rs` + `mesh/protocol.rs` (see `docs/archive/SESSION-1.8.0-OTA-PROGRESS.md`) and explicitly avoiding `mesh/listener/session.rs` transport plumbing + `mesh/mod.rs` routing, which this work owns. Stay out of `meshtastic.rs`/`protocol.rs` to avoid collisions. diff --git a/docs/architecture.md b/docs/architecture.md index 32e352f1..59d5550d 100644 --- a/docs/architecture.md +++ b/docs/architecture.md @@ -6,7 +6,7 @@ **Target OS**: Debian 13 (Trixie) — x86_64 and ARM64 **Status**: Beta freeze (Phase 1: Feature Testing) -For the full interactive architecture review with diagrams and learning guide, see [`architecture-review.html`](architecture-review.html). +For the full interactive architecture review with diagrams and learning guide, see [`archive/architecture-review.html`](archive/architecture-review.html). --- @@ -176,7 +176,7 @@ All nodes federated over Tor with bidirectional DWN sync. Deploy via SSH key fro | Doc | Purpose | |-----|---------| -| [`architecture-review.html`](architecture-review.html) | Full interactive architecture guide with diagrams | +| [`archive/architecture-review.html`](archive/architecture-review.html) | Full interactive architecture guide with diagrams | | [`developer-guide.md`](developer-guide.md) | Dev setup, workflow, code conventions | | [`api-reference.md`](api-reference.md) | Complete RPC endpoint reference | | [`app-developer-guide.md`](app-developer-guide.md) | Building and publishing apps | @@ -185,6 +185,6 @@ All nodes federated over Tor with bidirectional DWN sync. Deploy via SSH key fro | [`operations-runbook.md`](operations-runbook.md) | Ops commands and emergency recovery | | [`multi-node-architecture.md`](multi-node-architecture.md) | Federation protocol design | | [`marketplace-protocol.md`](marketplace-protocol.md) | Decentralized app discovery via Nostr | -| [`security-code-audit-2026-03.md`](security-code-audit-2026-03.md) | Penetration test findings (33 findings, all remediated) | +| [`archive/security-code-audit-2026-03.md`](archive/security-code-audit-2026-03.md) | Penetration test findings (33 findings, all remediated) | | [`MASTER_PLAN.md`](MASTER_PLAN.md) | Phased roadmap and task tracking | | [`BETA-PROGRESS.md`](BETA-PROGRESS.md) | Current beta stabilization progress | diff --git a/docs/HANDOVER-2026-07-02-iso-feedback.md b/docs/archive/HANDOVER-2026-07-02-iso-feedback.md similarity index 100% rename from docs/HANDOVER-2026-07-02-iso-feedback.md rename to docs/archive/HANDOVER-2026-07-02-iso-feedback.md diff --git a/docs/INSTALL-SCREENS-DESIGN.md b/docs/archive/INSTALL-SCREENS-DESIGN.md similarity index 100% rename from docs/INSTALL-SCREENS-DESIGN.md rename to docs/archive/INSTALL-SCREENS-DESIGN.md diff --git a/docs/archive/README.md b/docs/archive/README.md new file mode 100644 index 00000000..a7d1a75e --- /dev/null +++ b/docs/archive/README.md @@ -0,0 +1,26 @@ +# docs/archive — historical records + +Documents here are **finished history**: completed session logs, handovers, +point-in-time status snapshots, security audits of past versions, and design +docs whose feature has since shipped. They are kept for provenance and are +**not** maintained — nothing in this directory describes the current system. + +For current state, start at: + +- `docs/UNIFIED-TASK-TRACKER.md` — what's open, priority-ordered +- `docs/PRODUCTION-MASTER-PLAN.md` — north star and workstream narrative +- `docs/architecture.md` — as-built system architecture +- `docs/ROADMAP.md` — public-facing roadmap + +| File | What it was | Why archived | +|------|-------------|--------------| +| `SESSION-1.8.0-OTA-PROGRESS.md` | Session narrative of the 1.8.0 OTA work | Superseded by the unified task tracker | +| `HANDOVER-2026-07-02-iso-feedback.md` | One-shot handover for the ISO feedback bug-bash | All fixes merged | +| `rust-orchestrator-migration.md` | Design for migrating container lifecycle from bash to Rust | Migration complete — `prod_orchestrator.rs` + `boot_reconciler.rs` are the live system | +| `demo-deployment-design.md` | Design for the public demo sandbox | Demo shipped; `docs/demo-build-info.md` is the live ops doc | +| `app-registry-status-2026-06-21.md` | Per-app migration snapshot from node .228 @ v1.7.99-alpha | Point-in-time snapshot; headline findings (immich legacy, meshtastic present) no longer true | +| `security-code-audit-2026-03.md` | March 2026 security audit of v0.1.0 (33 findings) | Historical record; top findings since remediated (Argon2id, persisted sessions, image verification) | +| `architecture-review.html` | Generated interactive architecture guide (2026-03) | Stale generated artifact; describes an early crate/app layout | +| `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) | diff --git a/docs/SESSION-1.8.0-OTA-PROGRESS.md b/docs/archive/SESSION-1.8.0-OTA-PROGRESS.md similarity index 100% rename from docs/SESSION-1.8.0-OTA-PROGRESS.md rename to docs/archive/SESSION-1.8.0-OTA-PROGRESS.md diff --git a/docs/app-registry-status-2026-06-21.md b/docs/archive/app-registry-status-2026-06-21.md similarity index 100% rename from docs/app-registry-status-2026-06-21.md rename to docs/archive/app-registry-status-2026-06-21.md diff --git a/docs/architecture-review.html b/docs/archive/architecture-review.html similarity index 100% rename from docs/architecture-review.html rename to docs/archive/architecture-review.html diff --git a/docs/demo-deployment-design.md b/docs/archive/demo-deployment-design.md similarity index 100% rename from docs/demo-deployment-design.md rename to docs/archive/demo-deployment-design.md diff --git a/docs/lora-functionality.html b/docs/archive/lora-functionality.html similarity index 100% rename from docs/lora-functionality.html rename to docs/archive/lora-functionality.html diff --git a/docs/rust-orchestrator-migration.md b/docs/archive/rust-orchestrator-migration.md similarity index 100% rename from docs/rust-orchestrator-migration.md rename to docs/archive/rust-orchestrator-migration.md diff --git a/docs/security-code-audit-2026-03.md b/docs/archive/security-code-audit-2026-03.md similarity index 100% rename from docs/security-code-audit-2026-03.md rename to docs/archive/security-code-audit-2026-03.md diff --git a/docs/three-mode-ui-design.md b/docs/archive/three-mode-ui-design.md similarity index 100% rename from docs/three-mode-ui-design.md rename to docs/archive/three-mode-ui-design.md diff --git a/docs/demo-build-info.md b/docs/demo-build-info.md index c49441a9..ce73e129 100644 --- a/docs/demo-build-info.md +++ b/docs/demo-build-info.md @@ -6,7 +6,7 @@ **Main/prod is untouched** — all demo work lives only on `demo-build`. A public, click-to-play demo of the Archipelago UI, 100% mock-data driven, -multi-visitor, deployed via Portainer. See also `docs/demo-deployment-design.md` +multi-visitor, deployed via Portainer. See also `docs/archive/demo-deployment-design.md` (original design) and `demo-deploy/` (thin prebuilt-image stack). ---