/ docs / README.md
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)*