Skip to content

docs: sync README with the completed M0–M2 state (drift audit fixes) - #27

Merged
mikim merged 1 commit into
mainfrom
docs/readme-final-sync
Jul 14, 2026
Merged

docs: sync README with the completed M0–M2 state (drift audit fixes)#27
mikim merged 1 commit into
mainfrom
docs/readme-final-sync

Conversation

@mikim

@mikim mikim commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

What

A 3-lens adversarial audit (status-table fact-check · issue-closure verification · consistency proofread) of the final README against the merged code surfaced 10 incremental-edit drift defects accumulated across PRs #18#26. This fixes all of them.

Highlights:

  • Status banner no longer claims the API "serves only health/demo endpoints" — replaced with an honest description of the text-only vertical slice (and the real remaining gaps: no auth, quiz stub, no PDF).
  • "All code authored on a single day" corrected: scaffold 2026-04-10, implementation 2026-07-14 (PRs feat: reproducible baseline and runnable API (M0) — closes #12, #13 #18chore: adopt Apache-2.0 for code; separate data-licensing policy — closes #16 #26).
  • Removed the stale "error notebook / review tasks" schema description (those models no longer exist).
  • Known gaps rewritten; M0–M2 marked complete; maintenance-gate items struck through where satisfied (DRI designation remains open).
  • Small factual fixes: scheduler test count, seed.mts, conditional readyz phrasing, product-route endpoint lists, Contributing focus.

The audit also confirmed every issue closure was legitimate — all acceptance criteria of #3/#5/#7/#12/#13/#14/#16 verified against code on main with green CI.

🤖 Generated with Claude Code

A 3-lens adversarial audit of the final README against merged code
surfaced 10 incremental-edit drift defects; this fixes all of them:

- Status banner: 'serves only health/demo endpoints' -> honest
  text-only vertical slice description (still pre-alpha, gaps listed)
- 'authored on a single day' -> scaffold (2026-04-10) vs current
  implementation (2026-07-14, PRs #18-#26)
- Schema bullet: removed 'error notebook / review tasks' (models are
  gone) -> remediation-loop entities
- Stray dangling database bullet merged into the list properly
- Scheduler row: 14 -> 12 unit tests; readyz phrasing conditioned on
  DATABASE_URL; seed.ts -> seed.mts; api layout comment lists product
  routes; migrations plural
- Known gaps rewritten to the real remaining gaps (auth, quiz-engine
  stub, PDF/storage); M0-M2 marked complete
- 'FSRS should be introduced' -> is implemented
- Maintenance-gate 30-day items struck through where satisfied
  (DRI still open)
- Local-development endpoint list includes the product routes
- Contributing section points past completed milestones

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mikim
mikim merged commit 87492a6 into main Jul 14, 2026
1 check passed
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