Commit Graph

5 Commits

Author SHA1 Message Date
85cfed2617 docs: add implementation plan and update roadmap 2025-11-01 12:11:27 -04:00
b3debc125f docs: restructure documentation for improved clarity and navigation
Reorganize documentation into user-focused, developer-focused, and deployment-focused sections.

**New structure:**
- Root: README.md (streamlined), QUICK_START.md, API_REFERENCE.md
- docs/user-guide/: configuration, API usage, integrations, troubleshooting
- docs/developer/: contributing, development setup, testing, architecture
- docs/deployment/: Docker deployment, production checklist, monitoring
- docs/reference/: environment variables, MCP tools, data formats

**Changes:**
- Streamline README.md from 831 to 469 lines
- Create QUICK_START.md for 5-minute onboarding
- Create API_REFERENCE.md as single source of truth for API
- Remove 9 outdated specification docs (v0.2.0 API design)
- Remove DOCKER_API.md (content consolidated into new structure)
- Remove docs/plans/ directory with old design documents
- Update CLAUDE.md with documentation structure guide
- Remove orchestration-specific references

**Benefits:**
- Clear entry points for different audiences
- No content duplication
- Better discoverability through logical hierarchy
- All content reflects current v0.3.0 API
2025-11-01 10:40:57 -04:00
1347e3939f docs: add web UI feature to v0.4.0 roadmap
Add comprehensive web dashboard interface to planned features for v0.4.0.

Web UI Features:
- Job management dashboard
  * View/monitor active, pending, and completed jobs
  * Start new simulations with form-based configuration
  * Real-time job progress monitoring
  * Cancel running jobs

- Results visualization
  * Performance charts (P&L over time, cumulative returns)
  * Position history timeline
  * Model comparison views
  * Trade log explorer with filtering

- Configuration management
  * Model configuration editor
  * Date range selection with calendar picker
  * Price data coverage visualization

- Technical implementation
  * Modern frontend framework (React, Vue.js, or Svelte)
  * Real-time updates via WebSocket or Server-Sent Events
  * Responsive design for mobile access
  * Chart library for visualizations
  * Single container deployment alongside API

The web UI will provide an accessible interface for users who prefer
graphical interaction over API calls, while maintaining the same
functionality available through the REST API.

Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-31 17:22:31 -04:00
4b25ae96c2 docs: simplify roadmap to focus on v0.4.0 only
Remove all future releases (v0.5.0-v0.7.0) and infrastructure/enhancement
sections from roadmap. Focus exclusively on v0.4.0 planned features.

v0.4.0 - Enhanced Simulation Management remains with:
- Resume/continue API for advancing from last completed date
- Position history tracking and analysis
- Advanced performance metrics (Sharpe, Sortino, drawdown, win rate)
- Price data management endpoints

Removed sections:
- v0.5.0 Real-Time Trading Support
- v0.6.0 Multi-Strategy & Portfolio Management
- v0.7.0 Alternative Data & Advanced Features
- Future Enhancements (infrastructure, data, UI, AI/ML, integration, testing)

Keep roadmap focused on near-term deliverables with clear scope.

Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-31 17:20:48 -04:00
5606df1f51 docs: add comprehensive roadmap for future development
Create ROADMAP.md documenting planned features across multiple releases.

Planned releases:
- v0.4.0: Enhanced simulation management
  * Resume/continue API for advancing from last completed date
  * Position history tracking and analysis
  * Advanced performance metrics (Sharpe, Sortino, drawdown)
  * Price data management endpoints

- v0.5.0: Real-time trading support
  * Live market data integration
  * Real-time simulation mode
  * Scheduled automation
  * WebSocket price feeds

- v0.6.0: Multi-strategy & portfolio management
  * Strategy composition and ensembles
  * Advanced risk controls
  * Portfolio-level optimization
  * Dynamic allocation

- v0.7.0: Alternative data & advanced features
  * News and sentiment analysis
  * Market regime detection
  * Custom indicators
  * Event-driven strategies

Future enhancements:
- Kubernetes deployment and cloud provider support
- Alternative databases (PostgreSQL, TimescaleDB)
- Web UI dashboard with real-time visualization
- Model training and reinforcement learning
- Webhook notifications and plugin system
- Performance and chaos testing

Key feature: Resume API in v0.4.0
- POST /simulate/resume - Continue from last completed date
- POST /simulate/continue - Extend existing simulations
- Automatic detection of completion state per model
- Support for daily incremental updates

Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-10-31 17:18:55 -04:00