docs: align documentation with live public API#26
Merged
Conversation
- Update README.md with correct install flow, public package surface, and Dukascopy-cache backtest entry points - Fix stale module paths across aggregation_guide, backtesting_guide, metrics_guide, risk_management, and strategy_guide Co-Authored-By: Paperclip <[email protected]>
radiusred-cody
bot
force-pushed
the
docs/rad-51-align-tradedesk-docs
branch
from
82015cc to
f2769cb
Compare
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
1 participant
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.
Summary
README.mdwith correct install instructions, public package surface, and Dukascopy-cache backtest entry pointsdocs/aggregation_guide.md: fixtradedesk.aggregation→tradedesk.marketdatadocs/backtesting_guide.md: replace stale CSV-based flow withBacktestClient.from_dukascopy_cache(...)andBacktestSpecdocs/metrics_guide.md: fixtradedesk.metrics→tradedesk.recordingdocs/risk_management.md: fixtradedesk.risk→tradedesk.portfolio,tradedesk.position→tradedesk.execution,tradedesk.indicators→tradedesk.marketdata.indicatorsdocs/strategy_guide.md: fix indicator imports →tradedesk.marketdata.indicatorsTest plan
.pyfiles modified, no mypy/ruff/pytest gate required🤖 Generated with Claude Code