V1 Documentation Overhaul

Rewrite every document a stranger reads so the project presents as a publication-grade product, not an internal R&D project. README, CHANGELOG, CONTRIBUTING, ARCHITECTURE — all four are stale, sprint-numbered, or undersized. This is the first of two scopes preparing for the 1.0.0 npm publish. This scope is docs only — no production code changes, no test changes. The second scope (v1-code-changes) handles CLI output polish, parser fixes, and build config.

verdict PASSscore 33 / 34findings 8 (0 risk · 1 debt · 7 obs)duration 1h 31mrejection cycles 1shipped May 3, 2026surface cli

Pipeline timeline

Intent to proven code in 1h 31m across Think, Plan, Build, and Verify.

Think
25m
Plan
9m
Build
47m
Verify
11m

Assertion ledger

34 claims, each independently verified. Showing 8 — show all →

IDSaysMatcher
A001The root README exists and is between 150 and 200 linesverifiedok
A002The README contains exactly 9 second-level sectionsverifiedfail
A003The README has CI, npm, and license badgesverifiedok
A004The README has an install section with npm install commandverifiedok
A005The README states the Claude Code boundary clearlyverifiedok
A006The README contains no hedge wordsverifiedok
A007All proof subcommands are visible in the READMEverifiedok
A008The README contains a scan output example blockverifiedok

Findings 8 total

obs→ closed
Contract A002 value stale — says 9 sections but spec mockup and implementation both show 7
debtpackages/cli/ARCHITECTURE.md→ closed
ARCHITECTURE.md claims 5 python detector files but filesystem has 4 — inherited from spec verified counts
obspackages/cli/package.json→ closed
prepublishOnly relies on relative ../../ path — breaks if package depth changes
obspackages/cli/package.json→ closed
README.md and CHANGELOG.md cannot be verified with npm pack --dry-run — only exist after prepublishOnly
obspackages/cli/tests/engine/detectors/documentation.test.ts→ closed
documentation.test.ts assertion removed for packages/cli/README.md — justified but reduces dogfood coverage
+3more findings

Integrity seal

scopesha256:09aeb90da1cdc...
contractsha256:e57d692795a03...
plansha256:e82583b2ca85f...
specsha256:ce0d03d8989dd...
build-reportsha256:fb1055ef66d55...
build-datasha256:b41aa8ca7317d...
verify-reportsha256:f3530cce20517...
verify-datasha256:528538da9d401...
audit cmd$ ana proof audit v1-documentation-overhaul   → all hashes match