Skip to content

docs(readme): add 'How keel works' section - #130

Merged
eaitbrahim merged 1 commit into
mainfrom
docs/readme-how-keel-works
Jul 23, 2026
Merged

docs(readme): add 'How keel works' section#130
eaitbrahim merged 1 commit into
mainfrom
docs/readme-how-keel-works

Conversation

@eaitbrahim

Copy link
Copy Markdown
Contributor

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:

  • The agent loop — poll → each live rule's detect()rails → preview → confirm/autonomy gateplace_order → log.
  • Rules-only, no manual order command — every order is rule output; the four rule kinds and that DCA is the one on a calendar cadence (the others fire on real market setups).
  • The un-overridable rails — allowlist, spend/exposure/concentration caps, kill-switch, drawdown & edge-decay breakers, no-martingale/no-stop-widening, feed/balance/attestation checks.
  • Confirm vs autonomy — changes who is asked, never what's allowed.
  • Halal + ships inert — long-only spot, no riba; nothing trades until a rule is 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

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>
@eaitbrahim
eaitbrahim merged commit 50f81f5 into main Jul 23, 2026
1 check passed
@eaitbrahim
eaitbrahim deleted the docs/readme-how-keel-works branch July 23, 2026 09:07
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.

1 participant