docs: sync root + rule docs to post-review codebase state#55
Merged
Conversation
Audit pass over every .md after merging 17 PRs (#38-#54) in the review cycle. Nothing behavioural changed; this PR just retires claims that no longer match the repo. Corrections: - README.md: bumped prerequisite from Node 22+/pnpm 9 to Node 22+/pnpm 10 (CI and Vercel pinned to Node 24 via .nvmrc). Updated test counts 185 -> 186 (shared) and 566 -> 571 (web) for a new TS total of 757; matches the counts verified at the end of the Cache Components PR. - CLAUDE.md: same test count update; replaced "Web + Worker" in the architecture + deployment tables with "Web (includes cron API route)" since apps/worker/ was deleted in PR #33 and the push pipeline now runs as /api/cron/push inside the web app. Dropped `worker` from the scope enum. Added a short Cache Components note pointing at the rule file instead of duplicating the pattern here. - .claude/rules/git-conventions.md: same scope enum fix, with a note explaining why `worker` was retired. Replaced the `fix(worker): ...` example with `fix(web): ...`. - .claude/rules/deployment.md: renamed "Worker Cron" section to "Cron Entry" (matches push-pipeline.md terminology), rewrote the deploy step and the Web+Worker cloud-services entry, and added Upstash Redis as an optional service now that PR #49 uses it for the cross-instance webhook rate limiter. - .claude/rules/notifications.md: removed the stale `apps/worker/src/channels/**` glob; clarified that the email renderer lives in packages/shared. - docs/staging-setup.md: every "Web + Worker" phrasing updated to reflect the single Vercel deployment that now hosts the cron route. No production references remain to `apps/worker/`, `pnpm@9.15.0`, or outdated test counts.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📊 Coverage Report
🤖 Generated by CI · thresholds enforced via vitest |
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
1 participant
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
Audit pass over every
.mdafter merging 17 PRs (#38–#54) in the review cycle. Nothing behavioural changed; just retire claims that no longer match the repo.Corrections
README.md: Node 22 → Node 22+ with CI/Vercel on Node 24 (via.nvmrc); pnpm 9 → pnpm 10.33.0. Test counts: shared 185 → 186, web 566 → 571, TS total 751 → 757.CLAUDE.md: same test count update; "Web + Worker" → "Web (includes cron API route)" everywhere (apps/worker/ deleted in PR refactor(worker): migrate from Railway to pg_cron + Vercel API route #33 — push pipeline now runs as/api/cron/pushinside the web app). Droppedworkerfrom the commit scope enum. Added a short Cache Components note pointing at.claude/rules/web-patterns.mdinstead of duplicating the pattern..claude/rules/git-conventions.md: same scope enum fix with explanation. Replacedfix(worker): ...example withfix(web): .....claude/rules/deployment.md: "Worker Cron" section → "Cron Entry" (matches push-pipeline.md terminology). Added Upstash Redis as an optional cloud service now that PR feat(web): upgrade rate-limiter to Upstash Redis with in-memory fallback #49 uses it for the cross-instance webhook rate limiter..claude/rules/notifications.md: removed the staleapps/worker/src/channels/**path glob; clarified that the email renderer lives inpackages/shared.docs/staging-setup.md: every "Web + Worker" phrasing updated to reflect the single Vercel deployment.Test plan
grepsweep confirms no remaining references toapps/worker/,pnpm@9.15.0,751 TS,185 tests,566 tests,Node.js 22+(without the updated Node 24 context), or "Web + Worker" as a claim about current state.apps/worker/are in explanatory sentences describing the removal (CLAUDE.md, deployment.md, git-conventions.md).