Repository navigation
docs(readme): "Teach your AI agent what not to do" lead, adoption routes, FAQ (RW-3) - #90
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. The quickstart block is unchanged, so the generated figures and docs/quickstart.sh still match. 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:28
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
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 (context-report half). README.md only. Merge after chock RW-1 (cover and
adopt.pngare chock's raw PNG URLs).Facts table
paper/context-report.mdrows ~283-285registry.yamlat9a64623Claims checked against code
grep -rln "urllib\|anthropic\|http.client\|socket\|requests" src/context_report/produceempty at3a1c0c3; onlyefficacy/andrun/use them.pyproject.toml; predicate type fromsrc/context_report/rows.py.992711a).tools/quickstart_block.py README.mdequalsdocs/quickstart.shbody.Outline
Before: The problem, 30-second quickstart, What a report looks like, Three measurements, Who it's for, Two models, Use as a library, Supported agents, Contributing, Part of open-coder-ai, License.
After: Application security for the code your agents write, Install, 30-second quickstart, How it works (Two models, Use as a library), What it stops (Three measurements, Who it's for), Supported agents, FAQ for people and agents, For tools and agents, Contributing, Part of open-coder-ai, License.
Checks
pytest tests/test_quickstart_block.py: 5 passed.ruff check .,ruff format --check .: clean. Figure scripts rerun (cd docs/figures && python make_*.py):git statusshows only README.md changed. Self-check grep (pip install chock, free forever, never leaves, would have prevented, [stars], rtk, hallucinat, 100%): 0 hits.Notes
family-*.svgis stale (39 policies, "four plugin repositories") but its generatordocs/figures/make_family.pyhard-codes both, so regenerating cannot fix it; the README no longer embeds it and uses a text table. The script is byte-shared across four repos, so the fix belongs in a separate item.🤖 Generated with Claude Code
Generated by Claude Code