docs

iTrade Documentation

欢迎来到 iTrade 项目文档中心！

📖 Chinese Version: README_CN.md (Coming soon)

---

📚 Documentation Navigation

📖 User Guides (guides/)

Start here if you're new to iTrade:

Quick Start:

• Project Quick Start - Get started with iTrade
• Quick Start (CN) - 快速入门（中文）
• Run Commands - Common commands reference

Strategy Guides:

• Strategy Management Guide - How to manage strategies
• Strategy Debug Guide - Debug trading strategies
• Strategy Example (CN)
• Strategy Example (EN)
• Strategy Flow (CN)
• Strategy Flow (EN)

Exchange Guides:

• Multi-Exchange Guide
• OKX Exchange Guide

Subscription Guides:

• Auto Subscription Usage
• Subscription Quick Start

Documentation Guides:

• Documentation Guide
• Documentation Organization Complete
• Documentation Organization Summary

🏗️ Architecture (architecture/)

System design and architecture decisions:

• Trading Engine Analysis
• Market Data API Design Analysis
• Auto Subscription Design

🔌 API Reference (api/)

API documentation and interface references:

• Market Data API Reference

🛠️ Development (development/)

Development process and implementation documentation:

Implementation & Improvements:

• Console & Web Improvements
• Implementation Summary
• Improvements Summary
• Final Summary

Mobile Development:

• Mobile Strategy Implementation
• Mobile Strategy Enhanced

Bug Fixes:

• Order Tracker Fix

Documentation Updates:

• Documentation Organization
• Documentation Organization (CN)
• Naming Convention Update
• Naming Convention Update (CN)

📝 Changelog (changelog/)

Changes, updates, and summaries:

Changelogs:

• Multi-Exchange Changelog
• Symbol Normalization Changelog

Summaries:

• Multi-Exchange Summary
• Typed Market Data Summary

Bug Fixes:

• Subscription Key Mismatch Fix

🚀 Migration Guides (migration/)

Migration guides for major updates:

• Typed Market Data Migration Guide

🐛 Troubleshooting (troubleshooting/)

Common issues and solutions:

• Troubleshooting Guide - Common problems and fixes
• WebSocket Blocked Solution
• Symbol Normalization

---

🌍 Bilingual Documentation

iTrade supports bilingual documentation (English and Chinese):

• Bilingual Documentation Guide - How to work with bilingual docs

Naming Convention:

• FILENAME.md - English version (default)
• FILENAME_CN.md - Chinese version

---

📦 Application & Package Documentation

Console Application

• Console Quick Start - Get started with Console app
• Console Documentation

Web Application

• Web Documentation

Mobile Application

• Mobile Documentation

Core Package

• Order Sync Mechanism - Order sync design
• Order Sync Implementation
• Order Sync Refactoring
• Order Sync Summary
• Core Package Documentation

---

🗂️ Documentation Structure

docs/
├── README.md                      # This file (Documentation index)
├── BILINGUAL_DOCUMENTATION.md     # Bilingual documentation guide
│
├── guides/                        # User guides and tutorials
│   ├── PROJECT_QUICK_START.md
│   ├── STRATEGY_MANAGEMENT_GUIDE.md
│   └── ... (16 files)
│
├── architecture/                  # Architecture and design documents
│   ├── trading-engine-analysis.md
│   ├── DESIGN-ANALYSIS-MARKET-DATA-API.md
│   └── ... (3 files)
│
├── api/                           # API reference documentation
│   └── API-REFERENCE-MARKET-DATA.md
│
├── development/                   # Development process documentation
│   ├── IMPLEMENTATION_SUMMARY.md
│   ├── IMPROVEMENTS_SUMMARY.md
│   └── ... (11 files)
│
├── changelog/                     # Changelogs and summaries
│   ├── CHANGELOG-MULTI-EXCHANGE.md
│   ├── SUMMARY-TYPED-MARKET-DATA.md
│   └── ... (5 files)
│
├── migration/                     # Migration guides
│   └── MIGRATION-GUIDE-TYPED-MARKET-DATA.md
│
└── troubleshooting/              # Troubleshooting guides
    ├── TROUBLESHOOTING.md
    ├── WEBSOCKET-BLOCKED-SOLUTION.md
    └── ... (3 files)

---

🎯 Quick Links

For New Users

1. Project Quick Start
2. Console Quick Start
3. Strategy Management Guide

For Developers

1. Development Documentation
2. Architecture Documentation
3. API Reference

Need Help?

1. Troubleshooting Guide
2. Documentation Guide

---

📝 Contributing Documentation

When creating new documentation:

1. Choose the right location:

   • User guides → guides/
   • Architecture docs → architecture/
   • API docs → api/
   • Development logs → development/
   • Changelogs → changelog/
   • Migration guides → migration/
   • Troubleshooting → troubleshooting/

2. Follow naming conventions:

   • Use UPPERCASE_WITH_UNDERSCORES.md for important docs
   • Use lowercase-with-hyphens.md for regular docs
   • English version: FILENAME.md (no suffix)
   • Chinese version: FILENAME_CN.md

3. Update this README: Add your document to the appropriate section

4. See: .cursorrules for AI documentation rules

---

🔍 Search Tips

• By Topic: Navigate to the appropriate section above
• By File Name: Use your IDE's file search
• By Content: Use grep or your IDE's search in files feature

---

Last Updated: 2025-10-09

Total Documents: 40+ files organized in 8 categories