README.md
1 # Documentation 2 3 This directory contains comprehensive documentation for AI System Optimization Series in both English and Chinese. 4 5 ## ๐ Directory Structure 6 7 ``` 8 docs/ 9 โโโ en/ # English documentation 10 โ โโโ index.md 11 โ โโโ quick-start.md 12 โ โโโ prerequisites.md 13 โ โโโ architecture.md 14 โ โโโ api-reference.md 15 โ โโโ performance-tuning.md 16 โ โโโ troubleshooting.md 17 โ โโโ learning-path.md 18 โ โโโ contributing.md 19 โ โโโ glossary.md 20 โ โโโ references.md 21 โโโ zh/ # Chinese documentation 22 โ โโโ index.md 23 โ โโโ quick-start.md 24 โ โโโ prerequisites.md 25 โ โโโ architecture.md 26 โ โโโ api-reference.md 27 โ โโโ performance-tuning.md 28 โ โโโ troubleshooting.md 29 โ โโโ learning-path.md 30 โ โโโ contributing.md 31 โ โโโ glossary.md 32 โ โโโ references.md 33 โโโ README.md # This file 34 ``` 35 36 ## ๐ Language Selection 37 38 - **English**: [Start here](./en/) 39 - **ไธญๆ**: [ไป่ฟ้ๅผๅง](./zh/) 40 41 ## ๐ Document Index 42 43 ### Getting Started 44 | English | ไธญๆ | Description | 45 |---------|------|-------------| 46 | [Quick Start](./en/quick-start.md) | [ๅฟซ้ๅผๅง](./zh/quick-start.md) | Set up environment and run examples | 47 | [Prerequisites](./en/prerequisites.md) | [ๅ็ฝฎ่ฆๆฑ](./zh/prerequisites.md) | Detailed installation guide | 48 49 ### Understanding the Project 50 | English | ไธญๆ | Description | 51 |---------|------|-------------| 52 | [Architecture](./en/architecture.md) | [้กน็ฎๆถๆ](./zh/architecture.md) | Module organization and data flows | 53 | [API Reference](./en/api-reference.md) | [API ๅ่](./zh/api-reference.md) | Function signatures and examples | 54 55 ### Optimization Guides 56 | English | ไธญๆ | Description | 57 |---------|------|-------------| 58 | [Performance Tuning](./en/performance-tuning.md) | [ๆง่ฝ่ฐไผ](./zh/performance-tuning.md) | Optimization parameters and best practices | 59 | [Learning Path](./en/learning-path.md) | [ๅญฆไน ่ทฏ็บฟ](./zh/learning-path.md) | Recommended study order | 60 61 ### Troubleshooting & Contributing 62 | English | ไธญๆ | Description | 63 |---------|------|-------------| 64 | [Troubleshooting](./en/troubleshooting.md) | [้ฎ้ขๆๆฅ](./zh/troubleshooting.md) | Common issues and solutions | 65 | [Contributing](./en/contributing.md) | [่ดก็ฎๆๅ](./zh/contributing.md) | Guidelines for contributors | 66 67 ### Reference 68 | English | ไธญๆ | Description | 69 |---------|------|-------------| 70 | [Glossary](./en/glossary.md) | [ๆฏ่ฏญ่กจ](./zh/glossary.md) | Technical terms and abbreviations | 71 | [References](./en/references.md) | [ๅ่่ตๆ](./zh/references.md) | External documentation and papers | 72 73 ## ๐ Version History 74 75 | Version | Date | Changes | 76 |---------|------|---------| 77 | v1.0.0 | 2026-04-16 | Complete bilingual documentation refactor | 78 | v0.3.0 | 2026-02-24 | Initial documentation setup | 79 80 --- 81 82 *For the main project README, see [../README.md](../README.md)*