docs: rewrite Tasks, Trades, and Deployment sections with accurate APIs#402
Merged
Conversation
…Is (#334) - tasks.md: Replace fabricated examples with real Task class (time_unit/interval) and @app.task() decorator usage - trades.md: Document actual Trade model attributes (opened_at, open_price, net_gain) and Context methods (get_trade, get_open_trades, add_stop_loss, etc.) - deployment.md: Replace generic Docker/VPS content with real CLI commands (iaf init, iaf deploy-aws-lambda, iaf deploy-azure-function) - Fix bug in app.py add_strategy() using non-existent worker_id instead of strategy_id - Uncomment and fix 2 eventloop tests (test_initialize, test_get_data_sources_for_iteration) - Update BacktestTradeOrderEvaluator constructor for new required params Closes #334
- Fix prism-react-renderer import for Docusaurus 3.x compatibility - Fix sidebar.js: replace missing doc IDs with actual files (data-sources, backtest_data) - tasks.md: add class-level attribute pattern alongside constructor pattern - Add show_docs.sh script for running docs locally (with --build option)
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
Resolves #334 — Documentation Update: Fill in Tasks, Trades, and Deployment Sections.
Documentation Changes
Taskclass API (time_unit/intervalparams,@app.task()decorator). Removed fabricatedname,cron, and string-based interval parameters that don't exist.Trademodel attributes (opened_at,open_price,net_gain,stop_losses,take_profits) and all Context methods (get_trade,get_open_trades,get_closed_trades,add_stop_loss,add_take_profit, etc.). Removed faketrade.side,trade.fee,trade.created_at.iaf init,iaf deploy-aws-lambda,iaf deploy-azure-function) and their actual options.Code Fixes
add_strategy()that used non-existentworker_idattribute instead ofstrategy_id(would crash when adding 3+ strategies).test_initialize,test_get_data_sources_for_iteration). UpdatedBacktestTradeOrderEvaluatorconstructor for new required params. Remaining 5 tests stay commented as they require live exchange data.Test Results
All 163 app tests pass with 0 failures.