docs: rewrite README guards-first per positioning research (hw-g7p5) - #256
docs: rewrite README guards-first per positioning research (hw-g7p5)#256vishnujayvel wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughREADME.md is repositioned around Claude Code guardrails and policy evaluation, with expanded operational documentation for wiring, analytics, status feeds, health checks, configuration, testing, security, maturity, navigation, and project messaging. ChangesREADME refresh
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 64: Revise the README sentence around “With hookwise” so it states that
hookwise reads and evaluates hookwise.yaml, while Claude Code only supplies tool
calls, receives results, and can help author rules. Avoid implying Claude Code
natively reads or supports the YAML without hookwise.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 41ced524-7761-4563-822b-e6d3b58e5c96
📒 Files selected for processing (1)
README.md
| ``` | ||
|
|
||
| One file. Claude Code reads it, understands it, and can even help you write new rules. No bash scripts to debug. | ||
| With hookwise: add a rule, remove a rule, done. Claude Code reads the YAML, understands it, and can even help you write new rules. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Clarify which component reads the policy.
hookwise loads and evaluates hookwise.yaml; Claude Code supplies the tool call and receives the result. Saying Claude Code “reads the YAML” may imply native support and cause users to expect this to work without hookwise wiring. Reword this to say hookwise reads the YAML, while Claude Code can help author it.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` at line 64, Revise the README sentence around “With hookwise” so
it states that hookwise reads and evaluates hookwise.yaml, while Claude Code
only supplies tool calls, receives results, and can help author rules. Avoid
implying Claude Code natively reads or supports the YAML without hookwise.
1 participant
Factory-authored (bead hw-g7p5, convoy readme-relaunch). Rewrites the README to lead with the guardrails & policy engine story per the 2026-07-11 positioning research: hero = blocked-dangerous-command example + the YAML guard rule; cost analytics + feed-daemon status line as flagship features; honest maturity labels on TUI (early), coaching (narrow), notifications (experimental — Anthropic ships native push since v2.1.110). Every claim cross-checked against the shipped command surface per the bead's V1 accuracy gate. (Published as a single squashed commit: the two mirror commits cherry-pick-conflict against GitHub's squash history; file content is identical to the factory's final state 406e3f8.)
DO NOT MERGE until Vishnu reviews — outward-facing marketing copy, human review gate per the bead brief.
🤖 Generated with Claude Code
https://claude.ai/code/session_01EjWqH4FMkdczkSagzXw3dQ
Summary by CodeRabbit