docs: bring every doc current for release - #91
Merged
Merged
Conversation
Audited CLAUDE.md, README.md and all 14 linked reference documents against the code as it actually stands, and corrected what had drifted. Six agents verified their assigned files against source, tests and git history rather than against the prose that was already there. The headline corrections: **Stale claims that were actively wrong** - README documented `/branch-commit` and `/pr` skills that no longer exist; the real ones are `/audit-deps` and `/release`. - README's "3 moderate postcss advisories" known issue is obsolete. `npm audit` now reports 0 vulnerabilities across 720 packages; next@16.3.5 bundles postcss@8.5.23. Replaced with the lockfile platform-drift rule, which is the actual standing hazard. - README's testing section claimed ~190 tests across 6 files. It is 1,015 tests across 59 files at 99.74% statements, with thresholds gated in CI. - auth.md claimed id_token nonce binding was on; f88a9f1 disabled it because MP never sends the claim. It also claimed customSession makes no API calls, but it resolves the MP User_ID from dp_Users. - security-headers.md contradicted itself on which CSP relaxations are dev-only. - OAUTH_LOGOUT_SETUP.md was largely NextAuth-era fiction, citing a file and a code path that do not exist. - The shared-actions README documented three modules (auth, analytics, notifications) that were never in the repo. - The provider README documented hand-written model files that do not exist and omitted three real public FileService methods. - The scripts README had the generated-interface example inverted and never mentioned the stored-procs generator at all. - query-syntax.md pointed at `/tables/{table}/get` (the real call is `GET /tables/{table}`) and cited MCP tools this repo does not have. Its ESCAPE-clause example used an empty escape character, which silently disables every escape sanitizeLikeValue emits. - datetimehandling.md's datetime-local recipe was invented and did the opposite of the real implementation. **Documented for the first time** - AuthorizationService, SessionContextService and DomainTimezoneService, none of which appeared in either root doc despite the role gate being the release's most significant change. - MP_SECURITY_ROLES and CSP_ENFORCE, including that CSP_ENFORCE is inverted on purpose so a typo fails loud. - The three error boundaries from 07a2bd9. - Coverage gating: per-glob thresholds plus the global backstop, and that Codecov is report-only so the thresholds are the real PR gate. - A new CLAUDE.md practice #13 on filter sanitization. filter-sanitize.ts is mandatory at every interpolation site and closed a real read-widening injection, but no rule covered it. - The three deliberate authorization carve-outs, so the rule stops reading as violated by its own exceptions. - The App Router default-export exception to the named-exports rule. Verified counts throughout: 301 MP tables, 603 generated model files, 19 UI components, 59 test files, 532 stored procedures. Docs only — no source changes. tsc, eslint and the full suite pass. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Release-readiness audit of
CLAUDE.md,README.mdand all 14 linked reference documents. Every factual claim was verified against the code, the tests and git history — not against the prose already there. Six agents worked concurrently, each owning a disjoint set of files.Docs only. No source changes.
What was actually wrong
Most of these were not "slightly out of date" — they were claims that would mislead someone acting on them.
README.md/branch-commitand/prskills that don't exist. Real ones are/audit-depsand/release.README.mdnpm auditnow reports 0 vulnerabilities across 720 packages.README.mdREADME.mdgetFilesByRecord({ tableName })— the real key istable; as written it queriesundefined.README.md/CLAUDE.mdCongregationtype that does not exist (it'sCongregations).README.mdcreateTableRecordsexamples usednew Date().toISOString()— the exact anti-pattern practice #11 forbids, in the snippet new contributors copy first.auth.mdf88a9f1disabled it because MP never sends the claim. Also claimedcustomSessionmakes no API calls.security-headers.mdOAUTH_LOGOUT_SETUP.mdsrc/auth.ts"line 63", a file that doesn't exist.shared-actions/README.mdauth,analytics,notifications) that were never in the repo.README.mdFileServicemethods.README.md--cleanwith--search, which would wipe all 603 files.query-syntax.md/tables/{table}/getvsGET /tables/{table}); cited MCP tools this repo doesn't have;ESCAPE ''silently disabled every escape.datetimehandling.mddatetime-localrecipe was invented and did the opposite of the real implementation.Documented for the first time
AuthorizationService,SessionContextService,DomainTimezoneService— absent from both root docs despite the role gate being this release's most significant change.MP_SECURITY_ROLESandCSP_ENFORCE, including thatCSP_ENFORCEis inverted on purpose so a typo fails loud (too strict) rather than silent (no policy).07a2bd9.fail_ci_if_error: false, so the thresholds are the real PR gate.filter-sanitize.tsis mandatory at every interpolation site and closed a real read-widening injection, but no rule covered it.Verified counts
301 MP tables · 603 generated model files · 19 UI components · 59 test files · 1,015 tests · 532 stored procedures · 99.74% statement coverage
Test plan
npx tsc --noEmit— cleannpm run lint— cleannpm run test:coverage— 1,015 passed, 99.74% statementsnpm audit— 0 vulnerabilitiesnpm run deps:verify— no lockfile driftFollow-ups not included here (kept this branch docs-only)
Surfaced by the audit, worth a separate PR:
src/proxy.ts:22— comment still says CSP "Ships asContent-Security-Policy-Report-OnlyuntilCSP_ENFORCE=true". False since67e1329; the polarity is inverted.src/components/contact-logs/contact-logs.tsx:65— comment claims "the app has no error boundary". Untrue since07a2bd9. The defensive code is still right; the stated reason isn't.src/app/(web)/contactlookup/page.tsx:3— deep-imports past the barrel export.src/components/sign-in/sign-in.tsx— the only feature component with no co-located test, and it holds the F3 open-redirect sanitizer and the double-OAuth guard.Regression guard for .claude/TODO/<x>.mdcomments naming deleted TODO files.disableIdTokenNonceBindingis not asserted by any test, so removing it would fail only at a real sign-in.🤖 Generated with Claude Code