Skip to content

docs: accuracy pass across CLAUDE.md, README and references - #105

Merged
chriskehayias merged 1 commit into
mainfrom
docs/accuracy-pass
Sep 29, 2026
Merged

chriskehayias merged 1 commit into
mainfrom
docs/accuracy-pass

Conversation

@chriskehayias

Copy link
Copy Markdown
Contributor

Summary

Every claim in CLAUDE.md, README.md and the linked docs was checked against the code; this fixes what was wrong or stale.

Errors fixed

  • CLAUDE.md validation example passed Contact_ID as $userId (the audit-log User_ID) — now taken from requireSecurityRole.
  • CLAUDE.md Zod note (z.interface() isn't a v4 API) and coverage thresholds ("100%" applied only to proxy.ts).
  • query-syntax.md worked example interpolated an unsanitized ID into $filter.
  • README: JWT→JWE sessions, removed "name split", CurrentUserProfile DTO, stale test/coverage counts removed (Codecov badge + thresholds instead).
  • shared-actions/README.md return type and removed roles/groups text; provider README --conditions=react-server.
  • Sign-in hardening advisory: affected range missed 65a3225 — now merge-base checks plus fix date.
  • .claude downstream playbook F3b grep missed src/app/signin/.
  • /audit-deps allowed a bare npm install without relocking; /release ignored --draft/--prerelease/--target.

Behavioral change

  • Node minimum raised to 22 (Node 20 is EOL): scripts/setup.ts check and "engines": {"node": ">=22"} (lockfile root mirrors it; deps:verify clean). CI already runs Node 22.

Drift / polish

  • README security notice is now an advisory table; project tree, Documentation links, Contributing/Support updated.
  • References: stale counts/line numbers, lockfile-job wording, x-nonce, force-dynamic pages, sql.db.md confirm-first note, TestCoverage.md marked historical, stale vitest.config.mts comments (comments only).
  • One MP host placeholder (your-instance.ministryplatform.com/ministryplatformapi) everywhere.

Test plan

  • npx vitest run — 85 files, 2034 passed / 3 skipped
  • npm run lint, npx tsc --noEmit, npm run deps:verify
  • Relative Markdown links checked (remaining hits are intentional fork-relative paths in playbooks)

🤖 Generated with Claude Code

Verified against the code; fixes factual errors, drift and broken guidance.

- CLAUDE.md: $userId example now takes the acting User_ID from
  requireSecurityRole (was Contact_ID); real Zod v4 differences; accurate
  coverage thresholds (only proxy.ts is 100%); Discord workflow; npx tsx;
  sign-out-broadcast; more reference docs.
- README: security notice as an advisory table; JWE sessions and the
  CurrentUserProfile DTO; no hard-coded test/coverage counts; Node 22
  minimum; project tree and Documentation links brought up to date;
  generator sample output consistent; Contributing/Support expanded.
- Node 22 minimum: setup.ts check and "engines" in package.json.
- References: sanitized worked $filter example; .pick() allowlist; stale
  counts and line numbers replaced; lockfile CI job runs in parallel;
  x-nonce header and force-dynamic pages; sql.db.md confirm-first note;
  TestCoverage.md marked historical; stale vitest.config comments.
- Security docs: sign-in advisory affected range + merge-base checks and
  fix date; direct private-reporting link in SECURITY.md; downstream
  playbook F3b grep covers src/app/signin/; write-attribution playbook
  marked superseded in part.
- Commands: /audit-deps relocks after any npm install; /release honors
  --draft/--prerelease/--target.
- Provider/shared-actions READMEs: CurrentUserProfile return type,
  react-server condition, guards.ts, one MP host placeholder everywhere.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@chriskehayias
chriskehayias merged commit 94b5f81 into main Sep 29, 2026
4 checks passed
@chriskehayias
chriskehayias deleted the docs/accuracy-pass branch September 29, 2026 22:30
@codecov

codecov Bot commented Sep 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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