Andrew Kaszubski
|
b05cc88797
|
docs: add comprehensive documentation for new modules - Issue #48
Documentation updates:
- CHANGELOG.md: Add entries for backtest, alerts, execution, memory,
portfolio, simulation, strategy modules (1672+ tests documented)
- docs/README.md: Add Module Reference section with links to new docs
- docs/modules/backtest.md: Complete backtest module documentation
- BacktestEngine, slippage/commission models
- ResultsAnalyzer metrics and trade statistics
- ReportGenerator for PDF/HTML/JSON/Markdown
- docs/api/rest-api.md: FastAPI REST API reference
- Authentication flow with JWT
- Strategies CRUD endpoints
- Error handling and configuration
Also fixes pytest conftest.py plugin conflict by removing explicit
pytest_plugins registration (pytest auto-discovers sub-conftest files)
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
2025-12-26 23:24:17 +11:00 |
|
Andrew Kaszubski
|
c0dfb21c00
|
feat(docs): add comprehensive documentation structure - Fixes #52
- Add docs/ directory with 17 documentation files
- Architecture: multi-agent-system, data-flow, llm-integration
- API Reference: trading-graph, agents, dataflows
- Guides: adding-new-analyst, adding-llm-provider, adding-data-vendor, configuration
- Testing: README, running-tests, writing-tests
- Development: setup, contributing
- Update PROJECT.md with TESTING STRATEGY requirements
- Add test_documentation_structure.py for validation
🤖 Generated with Claude Code
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
|
2025-12-26 10:18:50 +11:00 |