docs: separate paper from live, so a figure from one is never read as the other - #242
Merged
Conversation
… the other Conflating the two accounts is this project's most expensive confusion: a paper-run position size compared against live-account equity produced a confident wrong diagnosis. Nothing in the docs made the split explicit, and nothing on the dashboard says which account a number belongs to -- paper and live render in an identical layout. README gains a `Paper vs. live` section: the two deployments share nothing (config, database, allowlist, caps, schedule, history), a comparison table of the measured values, how to tell which is on screen (`equity_state_mode`) or on the command line (the `--config`/`--db` pair, where `--db` defaulting to `keel.db` is the trap), how order gating differs, and why sizing is a different calculation on each. It also reconciles "it fires hourly" with "it runs daily": both jobs have hourly triggers, both runners are day-stamped, and the trigger count is catch-up breadth rather than cadence. The TUI help gains a short `Which account is this?` section -- which field disambiguates, and that switching means relaunching with the other pair, since there is no in-app switch. Documentation only: no behaviour, default or config value changes. Co-Authored-By: Claude Opus 5 (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.
Why
Conflating the paper and live accounts is the single most costly confusion in this project. It produced a wrong diagnosis: a paper-run position size was checked against live-account equity, and the conclusion was wrong as a result.
Nothing in the docs made the split explicit, and nothing on the dashboard says which account a number belongs to — paper and live render in an identical layout. This makes the mistake hard to repeat.
What
README.md— new## Paper vs. livesection (placed before## Before trading live). It leads with the thing that causes errors — two separate accounts, separate databases, separate configs, separate schedules, separate histories, so a figure from one says nothing about the other — then a comparison table of the measured values, then:equity_state_modeon any dashboard, the--config/--dbpair on the command line, and that--dbdefaults tokeel.db, so a live command that omits it silently reads the paper database;mode: confirm, which asks for a typedyand fails closed headless unless autonomy is armed, cross-referencingConfirm vs. autonomy;RunAtLoad; both runners are day-stamped; the trigger count is catch-up breadth, not cadence, because launchd does not re-run an interval that passed while the machine was off. A failed cycle leaves no stamp and is retried next hour. The two differ only in anchor: paper is local-date, live is UTC-date.equity_override); live falls back tocaps.max_exposure_usdas a proxy. Same rule, same setup, same day, different quantities.keel/commands/tui.py— newWhich account is this?help section (a few lines, beforeLive balance): which field disambiguates, and that switching accounts means relaunching with the other--config/--dbpair, since there is no in-app switch.tests/commands/test_tui.py— one test in the existing section-scoped style, pinning that the help namesequity_state_mode, both flags,keel-live.db, and thekeel.dbdefault.Notes
pyproject.tomluntouched, nothing underdocs/experiments/touched.origin/mainalongside the open docs: explain the dashboard's field names and the four money settings #240. Both files that overlap are edited in separate, non-adjacent sections: this README section sits at the end of the file rather than next to docs: explain the dashboard's field names and the four money settings #240's### How much money moves(which it cross-references instead of restating), and the TUI section sits beforeLive balancerather than at docs: explain the dashboard's field names and the four money settings #240's Glossary anchor. No new module-level test helper, so docs: explain the dashboard's field names and the four money settings #240's_help_section()cannot collide.Gates
Baseline on
origin/mainis 2664 passed / 1 skipped; the +1 is the new test. The single skip is the expected one:🤖 Generated with Claude Code