docs: move 10 finished/historical docs into docs/archive/ with an index
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 <noreply@anthropic.com>
This commit is contained in:
parent
9c02fbf164
commit
9221d1bfaf
@ -23,7 +23,7 @@ Detailed sub-plans (all linked from the master):
|
|||||||
- App platform / packaging phases + security model → `docs/APP-PACKAGING-MIGRATION-PLAN.md`
|
- App platform / packaging phases + security model → `docs/APP-PACKAGING-MIGRATION-PLAN.md`
|
||||||
- Registry-distributed manifests (in progress) → `docs/registry-manifest-design.md`
|
- Registry-distributed manifests (in progress) → `docs/registry-manifest-design.md`
|
||||||
- External/decentralized marketplace for devs → `docs/marketplace-protocol.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`
|
- Production test gate (exit criterion) → `tests/lifecycle/TESTING.md`
|
||||||
|
|
||||||
## Commit & push every unit of work (never violate)
|
## Commit & push every unit of work (never violate)
|
||||||
|
|||||||
@ -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
|
- [ ] 🟢 **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
|
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
|
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").
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
@ -54,7 +54,7 @@ real nodes. Until then, this plan is the priority.
|
|||||||
|
|
||||||
- **~40 apps are manifest-based and Quadlet-migrated** (survive
|
- **~40 apps are manifest-based and Quadlet-migrated** (survive
|
||||||
`archipelago.service` restart + reboot). Exhaustive per-app table:
|
`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
|
- **Legacy holdout: immich** — the one app with **no manifest** and a hardcoded
|
||||||
Rust stack installer (in-cgroup, not Quadlet). 3 containers, healthy, live data.
|
Rust stack installer (in-cgroup, not Quadlet). 3 containers, healthy, live data.
|
||||||
The migration proof case.
|
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 |
|
| 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. |
|
| 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
|
(ProdContainerOrchestrator, BootReconciler 30s level-triggered reconcile, adoption
|
||||||
scan, Quadlet rendering) and `bulletproof-containers.md` (the six container failure
|
scan, Quadlet rendering) and `bulletproof-containers.md` (the six container failure
|
||||||
modes FM1–FM6 + the desired-state-first reconciler that fixes them).
|
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
|
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**
|
`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,
|
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.
|
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:**
|
**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.
|
**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
|
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:**
|
**What was done this session:**
|
||||||
1. ✅ **Local Rust release gate fixed and green.** `cargo test -p archipelago --bin archipelago` is
|
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`,
|
- **Design:** `architecture.md`, `app-developer-guide.md`,
|
||||||
`APP-PACKAGING-MIGRATION-PLAN.md`, `registry-manifest-design.md`,
|
`APP-PACKAGING-MIGRATION-PLAN.md`, `registry-manifest-design.md`,
|
||||||
`marketplace-protocol.md`, `dht-distribution-design.md`,
|
`marketplace-protocol.md`, `dht-distribution-design.md`,
|
||||||
`multi-node-architecture.md`, `rust-orchestrator-migration.md`,
|
`multi-node-architecture.md`, `archive/rust-orchestrator-migration.md`,
|
||||||
`bulletproof-containers.md`, `three-mode-ui-design.md`, `dual-ecash-design.md`,
|
`bulletproof-containers.md`, `archive/three-mode-ui-design.md`, `dual-ecash-design.md`,
|
||||||
`meshroller-integration-design.md`, `phase4-streaming-ecash-plan.md`, `adr/*`.
|
`meshroller-integration-design.md`, `phase4-streaming-ecash-plan.md`, `adr/*`.
|
||||||
- **Reference:** `app-manifest-spec.md`, `api-reference.md`, `developer-guide.md`,
|
- **Reference:** `app-manifest-spec.md`, `api-reference.md`, `developer-guide.md`,
|
||||||
`operations-runbook.md`, `troubleshooting.md`, `user-walkthrough.md`,
|
`operations-runbook.md`, `troubleshooting.md`, `user-walkthrough.md`,
|
||||||
`bitcoin-rpc-relay.md`, `security-code-audit-2026-03.md`, `GAMEPAD-NAV.md`,
|
`bitcoin-rpc-relay.md`, `archive/security-code-audit-2026-03.md`, `GAMEPAD-NAV.md`,
|
||||||
`SEED-VERIFICATION.md`, `hotfix-process.md`, `app-registry-status-2026-06-21.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
|
All dated handoffs/resumes/transcripts/superseded trackers were consolidated here
|
||||||
and removed (recoverable via git) on 2026-06-21.
|
and removed (recoverable via git) on 2026-06-21.
|
||||||
|
|||||||
@ -8,7 +8,7 @@ Full plan: `.claude/plans/enchanted-strolling-rocket.md`. Memory pointer:
|
|||||||
`project_reticulum_transport_plan.md` (auto-memory index).
|
`project_reticulum_transport_plan.md` (auto-memory index).
|
||||||
|
|
||||||
**Coordination note (2026-06-30):** a separate agent owns concurrent Meshtastic work, scoped to
|
**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
|
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.
|
owns. Stay out of `meshtastic.rs`/`protocol.rs` to avoid collisions.
|
||||||
|
|
||||||
|
|||||||
@ -6,7 +6,7 @@
|
|||||||
**Target OS**: Debian 13 (Trixie) — x86_64 and ARM64
|
**Target OS**: Debian 13 (Trixie) — x86_64 and ARM64
|
||||||
**Status**: Beta freeze (Phase 1: Feature Testing)
|
**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 |
|
| 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 |
|
| [`developer-guide.md`](developer-guide.md) | Dev setup, workflow, code conventions |
|
||||||
| [`api-reference.md`](api-reference.md) | Complete RPC endpoint reference |
|
| [`api-reference.md`](api-reference.md) | Complete RPC endpoint reference |
|
||||||
| [`app-developer-guide.md`](app-developer-guide.md) | Building and publishing apps |
|
| [`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 |
|
| [`operations-runbook.md`](operations-runbook.md) | Ops commands and emergency recovery |
|
||||||
| [`multi-node-architecture.md`](multi-node-architecture.md) | Federation protocol design |
|
| [`multi-node-architecture.md`](multi-node-architecture.md) | Federation protocol design |
|
||||||
| [`marketplace-protocol.md`](marketplace-protocol.md) | Decentralized app discovery via Nostr |
|
| [`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 |
|
| [`MASTER_PLAN.md`](MASTER_PLAN.md) | Phased roadmap and task tracking |
|
||||||
| [`BETA-PROGRESS.md`](BETA-PROGRESS.md) | Current beta stabilization progress |
|
| [`BETA-PROGRESS.md`](BETA-PROGRESS.md) | Current beta stabilization progress |
|
||||||
|
|||||||
26
docs/archive/README.md
Normal file
26
docs/archive/README.md
Normal file
@ -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) |
|
||||||
@ -6,7 +6,7 @@
|
|||||||
**Main/prod is untouched** — all demo work lives only on `demo-build`.
|
**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,
|
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).
|
(original design) and `demo-deploy/` (thin prebuilt-image stack).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user