Skip to content

docs: rescue v1.0-design-final.md into repo#20

Open
suzuke wants to merge 1 commit into
mainfrom
docs/add-v1-design-spec
Open

docs: rescue v1.0-design-final.md into repo#20
suzuke wants to merge 1 commit into
mainfrom
docs/add-v1-design-spec

Conversation

@suzuke
Copy link
Copy Markdown
Owner

@suzuke suzuke commented May 13, 2026

Why

Phase A reverse-engineering review (5-backend architectural diagnosis) surfaced that the entire v1.0 redesign sprint (M1a → M3) anchors on docs/v1.0-design-final.md as source-of-truth, but the file was never committed to the repo. References are everywhere:

A find . -name 'v1.0-design*' only returns the two demo gate files — the spec itself lives only in the author's local working dir.

Effect: every claim of "per spec §X.Y" is currently unverifiable by anyone except the author, and contributors / external reviewers cannot ground architectural debates in a tracked baseline.

What

Imports v1.0-design-final.md verbatim from the author's local notes (~/Documents/Hack/autocrucible-design-v1/, mirrored via /tmp/ac-v1.0-design-final.md).

  • 385 lines, dated 2026-04-25 (matches the M1a sprint kickoff commits on Apr 25-27)
  • Status: APPROVED FOR IMPLEMENTATION (v3.2, with 4 small invariants folded in)
  • Authored by suzuke; reviewed by codex (crucible-reviewer)
  • Contains: executive summary, v3 → v3.2 decision log, §INV-1..4, §M1a/M1b/M2/M3 deliverables, §3.x (CLI subscription), §4.x (AttemptNode / EvalResult), §11 (concurrency invariants)

No code or other doc changes. Single-file additive PR.

Test plan

  • Confirm the imported content is the intended v3.2 version (no stale draft)
  • Decide canonical location:
    • Option A: docs/v1.0-design-final.md (current — flat next to README / CHANGELOG)
    • Option B: docs/spec/v1.0-design-final.md (new subdir if more specs are planned)
  • Decide whether to add a docs/README.md index entry pointing readers at this spec
  • Optional: cross-link from CLAUDE.md so AI contributors hit it on first read
  • Verify references in module docstrings still parse correctly after the file lands (no path changes needed since they all say docs/v1.0-design-final.md)

Risks

  • None functional — pure docs addition
  • Spec contains historical decision-trail (v3 → v3.1 → v3.2 with reviewer verdicts); some readers may want a cleaner final-only version, but the trail is part of the value (matches PR description conventions used in M1a-M3)

🤖 Generated with Claude Code

Module docstrings, demo gates (M1B/M2/M3), and PR descriptions reference
docs/v1.0-design-final.md (§INV-1..4, §M1a/M1b/M2/M3, §3.x, §4.x, §11) as
the source-of-truth design spec, but the file was never committed — only
existed in author's local notes (~/Documents/Hack/autocrucible-design-v1/).

This commit imports the spec verbatim so that:
- New contributors / external reviewers can verify "per spec §X.Y" claims
- Historical sprint context (M1a-M3) is preserved in-repo
- Future redesign discussions can branch from a tracked baseline

Spec dated 2026-04-25 (matches M1a sprint kickoff).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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