Repository navigation
docs(readme): "Teach your AI agent what not to do" lead, adoption routes, FAQ (RW-3) - #169
Merged
Merged
Conversation
…ption routes Rewrite the README on the README-wave plan: new lead, application security as the first section, install lines for both adoption routes, an FAQ and a "For tools and agents" list. Counts are re-derived from matrix.enforcement_level() and registry.yaml. Quick start block is unchanged. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Signed-off-by: Jothi Mani Rajendran <250249270+jothimani-rajendran@users.noreply.github.com>
Say what the guard does (refuses known classes while the agent writes) instead of a result nobody has measured. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Signed-off-by: Jothi Mani Rajendran <250249270+jothimani-rajendran@users.noreply.github.com>
jothimani-rajendran
marked this pull request as ready for review
October 6, 2026 12:29
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.
README wave item RW-3 (agentseam half). README.md only. Merge after chock RW-1 (the cover and
adopt.pnglink chock'sdocs/assets/readme/PNGs by raw URL).Facts table
matrix.enforcement_level(a, e)overmatrix.agents()atc5d2a00pre_toollen(matrix.adapted_agents())registry.yamlat chock-catalog9a64623, count ofenforceseval_cases/eval_executed, same fileClaims checked against code
chock add --ref/--verify-sha/--skip-compile(src/chock/scaffold/add.py),chock sync --repo/--ci(src/chock/lifecycle.py),chock install --selection/--apply(src/chock/install/cli.py), all at chock992711a.src/agentseam:grep -rn "import socket\|urllib\|http.client\|requests" src/agentseamis empty.registry.yaml; tiers copied fromenforces; descriptions checked againstdescriptionfields.tools/quickstart_block.pyoutput equalsdocs/quickstart.shbody).Outline
Before: Quick start, What each agent can actually do, Supported agents, What it is for, Instructions and permissions, Verify a claim, Contributing, Part of open-coder-ai.
After: Application security for the code your agents write, Install, Quick start, How it works, What it stops, Supported agents, Beyond security guards (Instructions / Permissions / Verify), FAQ for people and agents, For tools and agents, Contributing, Part of open-coder-ai.
Checks
pytest tests/test_quickstart_block.py tests/test_repo_standards.py: 14 passed.ruff check .andruff format --check .: clean. Self-check grep for "pip install chock", "free forever", "never leaves", "would have prevented", "[stars]", "rtk", "hallucinat", "100%": all 0 hits.Notes
The
family-*.svgfigures say 39 policies and "four plugin repositories"; their generator (docs/figures/make_family.py) hard-codes this and is outside this item's Touches, so the README no longer embeds the figure and uses a text table instead. Reported to the orchestrator.🤖 Generated with Claude Code
Generated by Claude Code