docs: add CLAUDE.md with architecture and command reference#32
Conversation
Replaces the bare Headroom-only CLAUDE.md with full onboarding guidance: wrapper execution flow, module dependency chain, security model, test/lint commands, and config file locations table. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
PR Review: docs: add CLAUDE.md with architecture and command referenceThis is a documentation-only PR adding SummaryThe architecture description, execution flow, module dependency chain, security model, and config table are all accurate and well-organized. The "Commands" section is correct and matches the actual test files. Non-blocking observations1. Hardcoded local absolute paths in the Headroom section (maintenance impact: medium) Lines 92 and 101 embed machine-specific absolute paths:
These paths are useless to any other contributor and will silently mislead any Claude session not running on Andrew's machine. If future Claude sessions follow these paths, they'll get Suggestion: Replace the absolute path on line 101 with the relative form 2. "Do not edit manually" directive on a committed file (maintenance impact: low) Lines 83–84: This instruction made sense when the section lived only in a local AI context file. Now that it's committed in a PR, contributors will reasonably need to update it, and the directive is misleading. Consider changing it to 3. Minor: table alignment inconsistency in config file locations (maintenance impact: negligible) Line 70: Security, bugs, regressionsNone found. This PR adds only documentation. VERDICT: PASS |
Summary
Test plan
npx markdownlint-cli --config ~/.markdownlint.json CLAUDE.md)🤖 Generated with Claude Code