docs(repo): per-component AGENTS.md/README + monorepo-map root#730
Conversation
Code ReviewerVerdict: Ready to merge (one minor doc fix recommended) Build: ✅ Pass — Files read
Source verificationEvery material claim was checked against the actual codebase:
One issue that needs attention
Both files say "18 methods" but The list of method names in What works wellThe root The Path-hop math for native helpers ( Note on per-component symlinksThe docs say Reviewed by Code Reviewer — actually ran the build and tests on this branch. |
Rpc.cs dispatches 19 methods (ping..notify); the inline list already had all 19, only the count was stale. Flagged by the PR #730 non-author review. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Code ReviewerVerdict: Ready to merge Build: Green — Source-grounding verificationEvery factual claim in the new/modified docs was verified against the live tree. Files read:
Changes that work well
Things to verify manually
Reviewed by Code Reviewer — read root AGENTS.md + all 6 new/modified doc files; cross-checked every factual claim against the live source tree before writing this review. |
The apps/+packages/+native restructure left the docs behind: the root
AGENTS.md still described src/, packages/menubar-helper, scripts/ as living
at repo root (they moved into apps/cli/), and several components had no
navigation doc at all.
- Root AGENTS.md → monorepo map + repo-wide policy (canonical-memory rule,
worktree rule, frozen VS Code publish identity, brand, security). The
CLI deep-dive it used to carry now lives with the CLI.
- apps/cli/AGENTS.md (new) → CLI internal architecture: design choices,
module map, bundled-native-helper resolution + path-hop math, build,
release mechanics. Complements the user-facing README.
- native/computer-win/{README,AGENTS}.md (new) → the C#/.NET Windows helper
(previously undocumented): TCP+ssh transport, Task Scheduler lifecycle,
no-TCC model, single-file self-extract gotcha.
- native/computer-mac/AGENTS.md (new) → short map atop the existing README.
- packages/session-tracker/{README,AGENTS}.md (new) → the SessionStart-hook
writer, and its hard distinction from the CLI's session reader surface.
All claims are source-grounded (file:line verified).
Rpc.cs dispatches 19 methods (ping..notify); the inline list already had all 19, only the count was stale. Flagged by the PR #730 non-author review. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
e0dbbb2 to
49ad568
Compare
Why
The
apps/+packages/+native/restructure (#724) moved the CLI intoapps/cli/but left the docs behind:AGENTS.mdwas drifted — it's the canonical memory file (auto-loaded every session) yet still describedsrc/,packages/menubar-helper, andscripts/as living at repo root. They moved intoapps/cli/. So the map every agent reads first was actively wrong.native/computer-win(the C#/.NET Windows helper) had zero docs;packages/session-trackerhad none;apps/clihad a user-facing README but no agent map.What changed
AGENTS.md(root)apps/cli.apps/cli/AGENTS.mdsrc/lib/module map, the bundled-native-helper resolution table + path-hop math (4 hops tonative/, 3 to co-locatedmenubar/), build, and release mechanics. Complements the user-facing README (which it does not duplicate).native/computer-win/README.md+AGENTS.mdssh -Ltransport, Task Scheduler lifecycle, no-TCC model, single-file native-lib self-extract gotcha (#519), Unicode-typing fix (#554/#581).native/computer-mac/AGENTS.mdpackages/session-tracker/README.md+AGENTS.mdSessionStart-hook writer, its state-file format/location, and its hard distinction from the CLI'sagents sessionsreader (apps/cli/src/lib/session/) — two unrelated "session" surfaces that are easy to conflate.Also removed stale untracked leftovers (
packages/factory/,packages/menubar-helper/) from the working checkout — pure pre-restructure build cruft (0 tracked files); the real code is atapps/factoryandapps/cli/menubar.Verification
Every claim in these docs is source-grounded — resolver hops, package names, build commands, and gotchas were each verified against
file:linein the current tree (three parallel research passes overnative/computer-win,packages/session-tracker, and the post-restructureapps/cli). No behavior/code changes — docs only.