docs(readme): rewrite for the newcomer, led by the compliance engine - #300
Merged
Conversation
The README was an operator runbook; a stranger deciding whether to spend an afternoon here needs what is differentiated (19 rails, fails-closed attested screening, qabd as an executable check), the honest measured result stated by us first, the not-a-fatwa boundary, and a five-minute path that actually runs (#281). The operator content moved to docs/operator-runbook.md unchanged. Quickstart steps verified on a clean clone, including the AuthenticationError keel fetch raises without a CDP key -- stated rather than discovered at step four. tests/test_readme.py pins the structure so the README cannot quietly grow back into a runbook.
This was referenced Aug 16, 2026
Open
Merged
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.
Closes #281
The README was a 261-line operator runbook — right for the author's future self, wrong for a
stranger deciding whether to spend an afternoon here.
The new first screen
that fails closed, §65.4 qabd as an executable check; the trading agent is the reference
implementation on top, not the headline.
taker fee actually paid; viable intersection empty under production-faithful execution,
linking
docs/experiments/2026-08-13-restated-under-a-production-faithful-engine.md.Quickstart, verified end-to-end on a clean clone (that's why it says
keel rules seed,not
keel init: a clone has the trackedconfig.yamlandinitrefuses to overwrite it):Two honest caveats are in the text because they were measured:
keel fetchwithout a CDPkey dies in
AuthenticationError(tested), andkeel simulateon default rules reportsTRAIN MORE with the failing gates named — presented as the engine working, because it is.
Rest of the structure: condensed How-it-works (rules, rails, screening, confirm/autonomy,
ships-inert, the tighter-stop→larger-position mechanic), an architecture sketch naming the
three load-bearing places (
keel/execution/guards.py,keel/agent.py,packages/keel-broker-*port + entry point), a documentation map, and an ending that routesquestions to Discussions (now enabled) and contributions to CONTRIBUTING.md.
Moved, not deleted: deploying/upgrading releases, the paper-vs-live table and its
interactions, and "how much money moves" now live in
docs/operator-runbook.md(Part 2,verbatim in substance).
Tests (
tests/test_readme.py, red first): honest result above the fold + cited recordexists; quickstart commands verbatim incl. the CDP caveat and paper path; the three
architecture locations named; README ends with Discussions/CONTRIBUTING routing; operator
content present in the runbook and absent from the README (the anti-runnable-regression
guard).
Gates:
pytest2794 passed / 1 skipped,ruff checkclean,mypyclean.