docs: tell the framework story in the README - #1192
Open
bennycode wants to merge 1 commit into
Open
Conversation
bennycode
force-pushed
the
feat/graph-builder-ui
branch
from
July 13, 2026 14:43
4bb8e29 to
e1593a8
Compare
Lead with the idea-to-live-trading narrative instead of a package index: build a strategy visually or in code, prove it in a backtest that mirrors live execution, run it unchanged against a real broker. Adds a hero screenshot of the visual strategy builder and updates highlights, packages, and the architecture diagram to cover strategy graphs.
bennycode
force-pushed
the
feat/graph-builder-ui
branch
from
July 13, 2026 14:44
e1593a8 to
0d7dd5b
Compare
bennycode
force-pushed
the
docs/readme-framework-story
branch
from
July 13, 2026 14:44
4138a9f to
d0ab84b
Compare
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The README’s hand-written strategy example references types that aren’t imported, so the snippet won’t type-check when copied.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates the repository README to lead with the “full loop” framework narrative: build a strategy (visually or in code), validate it via backtesting that mirrors live execution, and run the same strategy object live through a broker + Telegram control.
Changes:
- Adds a hero image and a “From idea to live trading in three steps” section describing the visual strategy builder, GraphStrategy, and backtest/live parity.
- Updates Highlights, Quickstart wording, packages table, and the mermaid diagram to include the strategy graph/builder components.
- Refreshes wording to emphasize equivalence guarantees between backtests and live trading.
File summaries
| File | Description |
|---|---|
| README.md | Reframes the README around the visual strategy builder + graph strategies + backtest/live parity story, and updates highlights/diagram accordingly. |
Review details
- Files reviewed: 1/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+25
to
+29
| import {Strategy} from 'trading-strategies'; | ||
|
|
||
| // …and so is a hand-written class: return an OrderAdvice per candle, the framework owns the rest. | ||
| class MyStrategy extends Strategy { | ||
| protected async processCandle(candle: OneMinuteBatchedCandle, state: TradingSessionState) { |
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
The README read like a package index. What this repo can actually claim — and no other TypeScript project currently can — is a full loop: build a strategy visually or in code → prove it in a backtest that mirrors live execution → run the same object against a real broker. The README now leads with that story.
What changed
.github/images/strategy-builder.png), linked to the live page