Rewrite all three READMEs in plain language#3
Merged
Conversation
The previous version explained the safety mechanisms accurately but assumed the reader already knew terms like Bonferroni deflation, sign test, reward-hacking, and holdout discipline before they hit the first screen. Every README now opens with a jargon-free explanation of what the loop actually does, and a glossary in the root README defines the recurring terms once instead of re-explaining them inline everywhere. Same technical content and structure, no em dashes, no filler language. Verified: full repo dash/metaphor sweep clean, both example suites green (219 tests), verdict.py self-test green, all relative links resolve. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011t5gmHpHh68Jcigy5uPPEx
5 tasks
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.
Summary
Follow-up to #1 and #2 (both merged): a readability pass on the root README and both example READMEs.
The previous version explained the safety mechanisms accurately but assumed the reader already knew terms like Bonferroni deflation, sign test, reward-hacking, and holdout discipline before they hit the first screen. This rewrite:
Test plan
.git/__pycache__../../README.mdcross-links,template/sandbox/,template/INSTANTIATE.md,LICENSE, etc.)examples/prompt-technique-tournament:python -m pytest eval/ -q(129 passed)examples/latency-tuner:python -m pytest sim/ -q(90 passed)python3 template/tools/verdict.py self-test(all 6 checks pass)https://claude.ai/code/session_011t5gmHpHh68Jcigy5uPPEx
Generated by Claude Code