Skip to content

docs: make the repo self-sufficient for a cold session (migration readiness, round 1) - #26

Merged
budhash merged 1 commit into
mainfrom
docs/migration-readiness
Jul 16, 2026
Merged

budhash merged 1 commit into
mainfrom
docs/migration-readiness

Conversation

@budhash

@budhash budhash commented Jul 16, 2026

Copy link
Copy Markdown
Owner

Preparing a machine move: the repo must carry everything a fresh session needs, since machine-local memory won't travel. A blind reader (fresh agent, zero context, fresh clone of main) audited the repo and answered a resume questionnaire; this PR closes the gaps it found.

Findings → fixes

Blind-reader finding Treatment
"155 scenarios" stale in README + CLAUDE.md (actual: 54 scenarios / 298 assertions; the noun was wrong even at v1.0.0) Fixed, version-pinned ("as of v1.4.0") + pointer to make test for the live count
Layout tables omit LEARNINGS.md, MEMORY.md, docs/superpowers/specs/, CHANGELOG.md Rows added in both tables
CLAUDE.md roadmap lags three releases; queue/resume point not derivable from repo Roadmap points at the issue tracker + new MEMORY.md, which pins the resume point (#14 next, agreed v1 scope, queue order after it)
Issue-vs-PR numbering (#N vs (#N)) and the docs/superpowers/ name unexplained One-line conventions added
Off-repo facts (vendored consumers taxjot/byteorb/stead, upstream/mirror standing rule, pending byteorb umbrella task, bootstrap steps) lived only in machine-local memory Written into MEMORY.md (explicitly ranked below CLAUDE.md)
validate silently ignores unknown argv and exits 0 (real code finding) Filed as #25 — behavior change, kept out of this docs PR; noted in MEMORY.md to fold into the #14 round

Not changed on purpose

Historical CHANGELOG entries (including v1.0.0's "155-scenario" phrasing) — the changelog is a record; present-tense docs are the ones that must be true.

make check green (298/298). Round 2 blind read runs after this merges.

https://claude.ai/code/session_01UquRBmRrh52iyPFuFQna5q

Blind-reader audit of a fresh clone (round 1) found the gaps below; this
closes them so a session with no machine-local memory can resume from the
repo alone:

- MEMORY.md (new): successor briefing ranked below CLAUDE.md — pinned
  resume point (#14 next, queue order), what just happened, off-repo
  context (vendored consumers, upstream/mirror rule, pending byteorb
  umbrella task), new-machine bootstrap.
- CLAUDE.md: read order for fresh sessions; layout table gains
  docs/superpowers/specs/, LEARNINGS.md, MEMORY.md, CHANGELOG.md; stale
  '155 scenarios' corrected (54 scenarios / 298 assertions as of v1.4.0);
  roadmap now points at the issue tracker + MEMORY.md; conventions gain
  branch/PR flow, issue-vs-PR numbering, and the TDD/spec-doc norm.
- README.md: layout table same corrections.

The audit also found validate silently ignoring unknown argv — filed as
#25 rather than fixed here (behavior change, separate concern).

Claude-Session: https://claude.ai/code/session_01UquRBmRrh52iyPFuFQna5q
@budhash
budhash merged commit b58de34 into main Jul 16, 2026
5 checks passed
@budhash
budhash deleted the docs/migration-readiness branch July 16, 2026 06:39
budhash added a commit that referenced this pull request Jul 16, 2026
Second blind cold-clone audit (after #26) found four residuals:

- examples/TASKS.md predated milestones despite being billed as fully
  populated: add a # Milestones registry (M1/alpha, M2/beta), assign
  @milestone via the CLI (F-0001 -> m1, T-0004 -> beta), and add
  @milestone= to the Meta tag list. Still validates; rollup works.
- CHANGELOG v1.0.0 '155-scenario' mislabel: additive editor's note
  (155 counted assertions; suite was 30 scenarios / 155 assertions) —
  entries stay unrewritten per convention.
- MEMORY.md overclaimed that every design decision has an in-repo spec;
  now states the milestone spec lived off-repo (taxjot) and where its
  surviving spec/rationale actually are.
- Wording: 'make test prints the live assertion count' (it does not
  print scenario counts); CLAUDE.md releasing now lists gh release
  create as standard practice (matches every release since v1.1.0).

Claude-Session: https://claude.ai/code/session_01UquRBmRrh52iyPFuFQna5q
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant