Skip to content

Rewrite all three READMEs in plain language#3

Merged
mboss37 merged 1 commit into
mainfrom
claude/self-improving-loops-rating-ufufj5
Jul 1, 2026
Merged

Rewrite all three READMEs in plain language#3
mboss37 merged 1 commit into
mainfrom
claude/self-improving-loops-rating-ufufj5

Conversation

@mboss37

@mboss37 mboss37 commented Jul 1, 2026

Copy link
Copy Markdown
Owner

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:

  • Opens every README with a jargon-free explanation of what the loop actually does, before any technical vocabulary.
  • Adds a glossary in the root README that defines the recurring terms once (gate, holdout, candidate budget, fails closed, reward-hacking, guardrail/floor, sandbox, statistical significance test) instead of re-explaining them inline everywhere.
  • Reworks the failure-mode table and example write-ups into plain sentences.
  • Keeps the same technical content, structure, and section order; this is a wording pass, not a scope change.
  • No em dashes, no filler/AI-buzzword phrasing (checked with a targeted grep).

Test plan

  • Repo-wide grep for em/en dashes and forge/anvil/jail/blacksmith language: zero matches outside .git/__pycache__
  • Targeted buzzword grep (leverage, seamless, robust, delve, elevate, etc.): zero matches
  • All relative links in the three READMEs verified to resolve (../../README.md cross-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)
  • Guardrail Floor 2 parity check reproduced locally (byte-identical across template and both examples), matching what CI enforces

https://claude.ai/code/session_011t5gmHpHh68Jcigy5uPPEx


Generated by Claude Code

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
@mboss37
mboss37 merged commit 8e164ca into main Jul 1, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants