docs: update README and CLAUDE.md with current state#344
Conversation
- Test count: 1607 → 2587 (177 suites) - Add packages architecture (@mitzo/protocol, @mitzo/harness, @mitzo/client) - Add 10th page (TaskBoard), 48 components, 21 hooks, 27 lib files - Add missing skills (/land-pr, /pr-shepherd) - Add APNS, OTEL, Loki, ContexGin env vars (~30 total) - Restructure backend section with categorized file tables Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
dimakis
left a comment
There was a problem hiding this comment.
Centaur Review
Found 5 issue(s) (3 warning).
CLAUDE.md
Docs-only PR with solid reorganization. A few count mismatches (components: 48 vs 51 actual, lib: 27 vs 28 actual) and useChatMessages listed under the wrong directory. Hardcoded test counts will go stale quickly.
- 🔵 unsafe_assumptions (L20): Hardcoded test count "2587 tests across 177 suites" will go stale as soon as tests are added or removed. Consider a range or removing the count entirely (the command
npm testis self-documenting). The previous value "22000+" was already wrong, and this replacement will be too eventually.[fixable] - 🟡 bugs (L110): Component count says "48 components" but there are 51 actual component files in
frontend/src/components/. Additionally,ChatArea.tsxexists in the repo but is missing from the enumerated list.[fixable] - 🟡 bugs (L94): Lib count says "27 utility files" but there are 28 actual files in
frontend/src/lib/(excluding tests). The enumerated list in the same section also has 28 items, contradicting the header count.[fixable] - 🟡 bugs (L86):
useChatMessagesis listed under "Hooks —hooks/directory (21 hooks)" but doesn't exist infrontend/src/hooks/. It lives in@mitzo/client(packages/client/src/slices/messages.ts). Either move this entry to the Packages section or clarify its location. The hook count of 21 is correct for files infrontend/src/hooks/, but the listing adds an extra entry that isn't there.[fixable]
README.md
Docs-only PR with solid reorganization. A few count mismatches (components: 48 vs 51 actual, lib: 27 vs 28 actual) and useChatMessages listed under the wrong directory. Hardcoded test counts will go stale quickly.
- 🔵 unsafe_assumptions (L254): Same hardcoded test count "2587 tests, 177 suites" — will drift out of date. This is the third distinct test count that has appeared across these two files (was "22000+" in CLAUDE.md and "1607 tests, 544 suites" in README.md).
[fixable]
| npm run format # Prettier (write) | ||
| npm run format:check # Prettier (check only) | ||
| npm test # Vitest (22000+ tests across all packages) | ||
| npm test # Vitest (2587 tests across 177 suites) |
There was a problem hiding this comment.
🔵 unsafe_assumptions: Hardcoded test count "2587 tests across 177 suites" will go stale as soon as tests are added or removed. Consider a range or removing the count entirely (the command npm test is self-documenting). The previous value "22000+" was already wrong, and this replacement will be too eventually. [fixable]
| - `notify.ts` — ntfy push notifications. | ||
| - `pushover.ts` — Pushover (Apple Watch) notifications. | ||
| - `apns.ts` — Apple Push Notification Service (iOS native). | ||
| - `notification-helpers.ts` — Shared notification formatting utilities. |
There was a problem hiding this comment.
🟡 bugs: Component count says "48 components" but there are 51 actual component files in frontend/src/components/. Additionally, ChatArea.tsx exists in the repo but is missing from the enumerated list. [fixable]
| - `task-orchestrator.ts` — `TaskOrchestrator`: event-driven state machine (idle/running/paused) with DFS sequential task assignment. Spec mode for human review of decompositions. Orphan detection reclaims tasks from dead sessions. | ||
|
|
||
| **Worktrees & Session Isolation** | ||
|
|
There was a problem hiding this comment.
🟡 bugs: Lib count says "27 utility files" but there are 28 actual files in frontend/src/lib/ (excluding tests). The enumerated list in the same section also has 28 items, contradicting the header count. [fixable]
| - `inbox.ts` — Inbox integration endpoint. | ||
|
|
||
| **Task Board** — Multi-session orchestration | ||
|
|
There was a problem hiding this comment.
🟡 bugs: useChatMessages is listed under "Hooks — hooks/ directory (21 hooks)" but doesn't exist in frontend/src/hooks/. It lives in @mitzo/client (packages/client/src/slices/messages.ts). Either move this entry to the Packages section or clarify its location. The hook count of 21 is correct for files in frontend/src/hooks/, but the listing adds an extra entry that isn't there. [fixable]
| @@ -155,7 +252,7 @@ See [docs/onboarding.md](docs/onboarding.md) for a full configuration walkthroug | |||
|
|
|||
| ```bash | |||
| npm run dev # backend + frontend concurrently | |||
There was a problem hiding this comment.
🔵 unsafe_assumptions: Same hardcoded test count "2587 tests, 177 suites" — will drift out of date. This is the third distinct test count that has appeared across these two files (was "22000+" in CLAUDE.md and "1607 tests, 544 suites" in README.md). [fixable]
Summary
Test plan
🤖 Generated with Claude Code