Skip to content

docs(M295): professional README + mdBook companion at paiml.github.io/claude-code-parity-apr#263

Merged
noahgift merged 1 commit into
mainfrom
m295-readme-and-book
May 22, 2026
Merged

docs(M295): professional README + mdBook companion at paiml.github.io/claude-code-parity-apr#263
noahgift merged 1 commit into
mainfrom
m295-readme-and-book

Conversation

@noahgift

Copy link
Copy Markdown
Contributor

Summary

  • book/ — full mdBook source, 28 chapters covering methodology, gates, empirical findings, CLI reference, and academic basis. Hosted at paiml.github.io/claude-code-parity-apr via GitHub Pages.
  • .github/workflows/book.yml — auto-build + auto-deploy on every push to main touching book/**.
  • README.md — restructured: clear badges row, book callout, empirical highlight section (the V1_004 chain table), clean architecture diagram, gates with deep-links to book chapters.

Book structure

Introduction
├── 01-overview/        what-is-ccpa, methodology, two-paths, architecture
├── 02-static-path/     trace-schema, differ, fixtures, bidirectional-sensitivity
├── 03-arena/           overview, phase-5, phase-6, outcomes
├── 04-gates/           gates (20), source-of-truth, behavioral-parity, status-flow
├── 05-findings/        v1004-chain, m286-m32d, m287-greedy, m291-pattern-shift,
│                       m292-text-loop, m294-finetune-ab
├── 06-reference/       cli, trace-schema, contract-yaml, gate-ids
└── 99-appendix/        academic-basis, milestone-history, glossary

What the book captures that the spec doesn't

  • Sequenced narrative: the V1_004 chain (M286 → M294) reads as one empirical story instead of 9 separate evidence files
  • Cross-references at the prose level (not just paper trail): "see Status flow" links inline
  • Glossary for fast onboarding
  • Single shareable URL: paiml.github.io/claude-code-parity-apr for reference in PRs, issues, talks

Test plan

  • mdbook build book/ — builds clean, no broken links
  • bash scripts/test-doc-drift.sh — 17/17 drift classes pass
  • bash scripts/check-doc-drift.sh — clean
  • .gitignore excludes book/book/ (generated)
  • CI builds book on this PR
  • On merge, GitHub Pages deploys the book

Cross-references

🤖 Generated with Claude Code

Adds:
- book/ — mdBook source for paiml.github.io/claude-code-parity-apr
- .github/workflows/book.yml — CI build + GitHub Pages auto-deploy
- README.md restructured for professional landing (badges row, book
  callout, empirical highlight section, deep-links to book chapters)
- .gitignore — book/book/ (generated artifact)

Book structure (28 chapters):
- Introduction
- Overview: what is CCPA, methodology, two paths, architecture
- Static path: trace schema, differ, fixtures, bidirectional sensitivity
- Arena: overview, phase 5, phase 6, outcome variants
- Falsification gates: 20 gates, source-of-truth, behavioral parity, status flow
- Empirical findings: V1_004 chain (M286, M287, M291, M292, M294)
- Reference: CLI, trace schema, contract YAML, gate IDs
- Appendix: academic basis, milestone history, glossary

Build locally: mdbook build book/ -> book/book/index.html
Deploy: GitHub Pages auto-deploys on push to main when book/ changes.

Doc-drift detector: 17/17 drift classes pass.

Refs:
- evidence/phase-6/v1004-*.md (all sourced into book chapters)
- CCPA#259 M291, #260 M292, #261 M293, #262 M294 scope

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@noahgift noahgift merged commit d216b7f into main May 22, 2026
2 of 3 checks passed
@noahgift noahgift deleted the m295-readme-and-book branch May 22, 2026 06:53
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