From b57ac196ea848b13da069056ed3d04b67819f59d Mon Sep 17 00:00:00 2001 From: Paolo Dettori Date: Wed, 8 Jul 2026 22:23:08 -0400 Subject: [PATCH] docs: adopt spec/ADR/plan lifecycle + prune coded plans MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Adopt an explicit documentation lifecycle and directory convention: - docs/specs/ — committed, point-in-time design docs (what & why) - docs/adrs/ — committed, permanent, immutable decision records - docs/plans/ — local-only, gitignored implementation checklists Code is the source of truth for *how*; the durable value of docs is the *why*. Plans go stale the moment code merges, so they are local-only. Changes: - Add docs/adrs/ (README + ADR template: Context/Decision/Consequences/Status). - Document the lifecycle and a Status vocabulary (Proposed → Accepted → Implemented → Superseded by ) in docs/specs/README.md. - Gitignore docs/plans/ (keep its README so the dir stays discoverable); repoint the writing-plans destination to docs/plans/. - Remove all 17 now-merged plans from docs/superpowers/plans/ and the now-empty docs/superpowers/ tree; the matching specs carry the why. Merge status confirmed against history — the three "verify before deleting" plans landed via PRs #5 (m7 cluster experiments), #14/#15 (human-gate), and #16 (registry hardening hygiene). Closes #79 Assisted-By: Claude (Anthropic AI) Signed-off-by: Paolo Dettori --- .gitignore | 5 + docs/adrs/0000-adr-template.md | 37 + docs/adrs/README.md | 46 + docs/plans/README.md | 30 + docs/specs/README.md | 33 +- .../2026-06-16-m1-redis-session-backend.md | 1167 -------------- .../plans/2026-06-17-m2-k8s-sandbox-client.md | 1262 --------------- .../plans/2026-06-17-m3-persistent-channel.md | 1027 ------------ ...026-06-17-m4-knative-serverless-wrapper.md | 1321 --------------- .../2026-06-23-m5-compaction-checkpoint.md | 824 ---------- .../plans/2026-06-24-m6-experiments.md | 1018 ------------ .../2026-06-25-m7-cluster-experiments.md | 614 ------- .../2026-06-26-mvp-leaf-session-contract.md | 793 --------- .../plans/2026-06-27-async-leaf-completion.md | 1273 --------------- .../plans/2026-06-28-human-gate.md | 1425 ----------------- .../2026-06-28-registry-hardening-hygiene.md | 345 ---- .../2026-06-28-scheduled-leaf-dispatch.md | 516 ------ ...26-07-02-p0prime-ocp-fs-free-deployment.md | 609 ------- .../plans/2026-07-02-p1-fs-free-harness.md | 1352 ---------------- .../2026-07-02-p2-shared-sandbox-pool.md | 1046 ------------ ...2026-07-03-e6-workload-parameterization.md | 623 ------- ...03-p3-sandbox-sharing-ratio-experiments.md | 1125 ------------- 22 files changed, 149 insertions(+), 16342 deletions(-) create mode 100644 docs/adrs/0000-adr-template.md create mode 100644 docs/adrs/README.md create mode 100644 docs/plans/README.md delete mode 100644 docs/superpowers/plans/2026-06-16-m1-redis-session-backend.md delete mode 100644 docs/superpowers/plans/2026-06-17-m2-k8s-sandbox-client.md delete mode 100644 docs/superpowers/plans/2026-06-17-m3-persistent-channel.md delete mode 100644 docs/superpowers/plans/2026-06-17-m4-knative-serverless-wrapper.md delete mode 100644 docs/superpowers/plans/2026-06-23-m5-compaction-checkpoint.md delete mode 100644 docs/superpowers/plans/2026-06-24-m6-experiments.md delete mode 100644 docs/superpowers/plans/2026-06-25-m7-cluster-experiments.md delete mode 100644 docs/superpowers/plans/2026-06-26-mvp-leaf-session-contract.md delete mode 100644 docs/superpowers/plans/2026-06-27-async-leaf-completion.md delete mode 100644 docs/superpowers/plans/2026-06-28-human-gate.md delete mode 100644 docs/superpowers/plans/2026-06-28-registry-hardening-hygiene.md delete mode 100644 docs/superpowers/plans/2026-06-28-scheduled-leaf-dispatch.md delete mode 100644 docs/superpowers/plans/2026-07-02-p0prime-ocp-fs-free-deployment.md delete mode 100644 docs/superpowers/plans/2026-07-02-p1-fs-free-harness.md delete mode 100644 docs/superpowers/plans/2026-07-02-p2-shared-sandbox-pool.md delete mode 100644 docs/superpowers/plans/2026-07-03-e6-workload-parameterization.md delete mode 100644 docs/superpowers/plans/2026-07-03-p3-sandbox-sharing-ratio-experiments.md diff --git a/.gitignore b/.gitignore index 126480d..7f2ae85 100644 --- a/.gitignore +++ b/.gitignore @@ -23,3 +23,8 @@ secrets.* # OS .DS_Store Thumbs.db + +# Implementation plans are local-only, ephemeral work artifacts (see docs/plans/README.md). +# They go stale the moment code merges; the durable "why" lives in docs/specs/ + docs/adrs/. +docs/plans/* +!docs/plans/README.md diff --git a/docs/adrs/0000-adr-template.md b/docs/adrs/0000-adr-template.md new file mode 100644 index 0000000..4ce6a41 --- /dev/null +++ b/docs/adrs/0000-adr-template.md @@ -0,0 +1,37 @@ +# ADR-NNNN: + +- **Status:** Proposed +- **Date:** YYYY-MM-DD +- **Deciders:** +- **Spec:** [`../specs/YYYY-MM-DD--design.md`](../specs/YYYY-MM-DD--design.md) + +## Context + +What forces a decision now? The problem, the constraints, the pressures. State the facts and +the forces at play — not the answer. Enough that a reader a year from now understands *why this +was even a question*. + +## Decision + +The choice, stated in one or two active-voice sentences: "We will …". Name the option picked. + +### Alternatives considered + +- **