docs(readme): add 'How keel works' section - #130
Merged
Conversation
Documents the agent loop (poll -> detect -> rails -> preview -> confirm/autonomy -> place -> log), the rules-only design (no manual order command), the four rule kinds and DCA's calendar cadence, the un-overridable rails, confirm vs autonomy, and the halal/ships-inert framing. Verified against guards.py, agent.py, executor.py, and the runbooks so it doesn't drift. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Adds a How keel works section to the root README, filling a real gap: the operating model (how orders actually get placed, why there's no manual trade command, DCA's calendar cadence) was previously only reconstructable from the design spec, runbooks, and code docstrings.
Covers, in a screenful:
liverule'sdetect()→ rails → preview → confirm/autonomy gate →place_order→ log.live, attested, funded, and confirmed.Verified against
guards.py,agent.py,executor.py, and the runbooks so it doesn't drift. Docs-only.🤖 Generated with Claude Code