52 lines
2.4 KiB
Markdown
52 lines
2.4 KiB
Markdown
|
# Orderflow Backtest System Documentation
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
This directory contains comprehensive documentation for the Orderflow Backtest System, a high-performance cryptocurrency trading data analysis platform.
|
||
|
|
|
||
|
|
## Documentation Structure
|
||
|
|
|
||
|
|
### 📚 Main Documentation
|
||
|
|
- **[CONTEXT.md](./CONTEXT.md)**: Current project state, architecture decisions, and development patterns
|
||
|
|
- **[architecture.md](./architecture.md)**: System architecture, component relationships, and data flow
|
||
|
|
- **[API.md](./API.md)**: Public interfaces, classes, and function documentation
|
||
|
|
|
||
|
|
### 📦 Module Documentation
|
||
|
|
- **[modules/metrics.md](./modules/metrics.md)**: OBI and CVD calculation system
|
||
|
|
- **[modules/storage.md](./modules/storage.md)**: Data processing and persistence layer
|
||
|
|
- **[modules/visualization.md](./modules/visualization.md)**: Chart rendering and display system
|
||
|
|
- **[modules/repositories.md](./modules/repositories.md)**: Database access and operations
|
||
|
|
|
||
|
|
### 🏗️ Architecture Decisions
|
||
|
|
- **[decisions/ADR-001-metrics-storage.md](./decisions/ADR-001-metrics-storage.md)**: Persistent metrics storage decision
|
||
|
|
- **[decisions/ADR-002-visualization-separation.md](./decisions/ADR-002-visualization-separation.md)**: Separation of concerns for visualization
|
||
|
|
|
||
|
|
### 📋 Development Guides
|
||
|
|
- **[CONTRIBUTING.md](./CONTRIBUTING.md)**: Development workflow and contribution guidelines
|
||
|
|
- **[CHANGELOG.md](./CHANGELOG.md)**: Version history and changes
|
||
|
|
|
||
|
|
## Quick Navigation
|
||
|
|
|
||
|
|
| Topic | Documentation |
|
||
|
|
|-------|---------------|
|
||
|
|
| **Getting Started** | [README.md](../README.md) |
|
||
|
|
| **System Architecture** | [architecture.md](./architecture.md) |
|
||
|
|
| **Metrics Calculation** | [modules/metrics.md](./modules/metrics.md) |
|
||
|
|
| **Database Schema** | [API.md](./API.md#database-schema) |
|
||
|
|
| **Development Setup** | [CONTRIBUTING.md](./CONTRIBUTING.md) |
|
||
|
|
| **API Reference** | [API.md](./API.md) |
|
||
|
|
|
||
|
|
## Documentation Standards
|
||
|
|
|
||
|
|
This documentation follows the project's documentation standards defined in `.cursor/rules/documentation.mdc`. All documentation includes:
|
||
|
|
|
||
|
|
- Clear purpose and scope
|
||
|
|
- Code examples with working implementations
|
||
|
|
- API documentation with request/response formats
|
||
|
|
- Error handling and edge cases
|
||
|
|
- Dependencies and requirements
|
||
|
|
|
||
|
|
## Maintenance
|
||
|
|
|
||
|
|
Documentation is updated with every significant code change and reviewed during the development process. See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on documentation maintenance procedures.
|