diff --git a/docs/README.md b/docs/README.md index 5982bb23..f528a09e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,10 +13,13 @@ Contains comprehensive guides for English-speaking users: - **Prompt Templates** (`prompt_templates.md`) - Ready-to-use prompt templates for various agent roles ### ๐Ÿ‡จ๐Ÿ‡ณ Chinese Documentation (`zh-CN/`) -**Status**: ๐Ÿšซ Excluded from version control (local development only) +**Status**: โœ… Included in version control -Contains detailed guides in Chinese for local development and customization: -- **้…็ฝฎๆŒ‡ๅ—** (`configuration_guide.md`) - ่ฏฆ็ป†็š„้…็ฝฎไฟฎๆ”นๅ’Œๆ็คบ่ฏๅฎšๅˆถๆŒ‡ๅ— +Contains comprehensive guides in Chinese for Chinese-speaking users: +- **ไธปๆ–‡ๆกฃ** (`README.md`) - ไธญๆ–‡็‰ˆ็ณป็ปŸๆฆ‚่งˆๅ’Œๅฟซ้€Ÿๅผ€ๅง‹ +- **้…็ฝฎๆŒ‡ๅ—** (`configuration_guide.md`) - ่ฏฆ็ป†็š„้…็ฝฎไฟฎๆ”นๅ’Œๆ–ฐๅŠŸ่ƒฝ่ฎพ็ฝฎๆŒ‡ๅ— +- **ๆžถๆž„ๆŒ‡ๅ—** (`architecture_guide.md`) - ็ณป็ปŸๆžถๆž„ๅ’ŒๆŠ€ๆœฏๅฎž็Žฐ่ฏฆ่งฃ +- **ๅฟซ้€Ÿๅผ€ๅง‹ๆŒ‡ๅ—** (`quick_start_guide.md`) - 5ๅˆ†้’Ÿๅฟซ้€Ÿ่ฎพ็ฝฎๅ’Œไฝฟ็”จๆ•™็จ‹ - **ๅฟซ้€Ÿๅ‚่€ƒ** (`quick_reference.md`) - ๆ–ฐๆ‰‹ๅ‹ๅฅฝ็š„ๅฟซ้€ŸๆŸฅๆ‰พๅก็‰‡ - **ๆ็คบ่ฏๆจกๆฟๅบ“** (`prompt_templates.md`) - ๅฏ็›ดๆŽฅไฝฟ็”จ็š„ๆ็คบ่ฏๆจกๆฟ @@ -30,19 +33,25 @@ Navigate to [`en-US/`](en-US/) directory for: - Troubleshooting tips ### For Chinese Users -Navigate to `zh-CN/` directory (local development) for: +Navigate to [`zh-CN/`](zh-CN/) directory for: - ็ณป็ปŸ้…็ฝฎ่ฏดๆ˜Ž +- ไธญๅ›ฝA่‚กๅธ‚ๅœบๅŠŸ่ƒฝ +- ็™พ็‚ผ(DashScope)้›†ๆˆๆŒ‡ๅ— +- ๆ•ฐๆฎๅบ“้…็ฝฎ่ฏดๆ˜Ž - ๆ็คบ่ฏๅฎšๅˆถๆŒ‡ๅ— -- ๆจกๆฟๅบ“ +- ๆžถๆž„ๆŠ€ๆœฏๆ–‡ๆกฃ - ๆ•…้šœๆŽ’้™คๆŠ€ๅทง ## ๐Ÿ“– Available Guides | Guide | English | Chinese | Description | |-------|---------|---------|-------------| -| **Configuration Guide** | [๐Ÿ“– View](en-US/configuration_guide.md) | ๐Ÿ“– View (Local) | Complete guide for modifying configurations and prompts | -| **Quick Reference** | [๐Ÿš€ View](en-US/quick_reference.md) | ๐Ÿš€ View (Local) | Quick lookup for common modifications | -| **Prompt Templates** | [๐ŸŽฏ View](en-US/prompt_templates.md) | ๐ŸŽฏ View (Local) | Ready-to-use prompt templates | +| **Main Documentation** | [๐Ÿ“– View](en-US/) | [๐Ÿ“– ๆŸฅ็œ‹](zh-CN/README.md) | System overview and quick start | +| **Configuration Guide** | [๐Ÿ“– View](en-US/configuration_guide.md) | [๐Ÿ“– ๆŸฅ็œ‹](zh-CN/configuration_guide.md) | Complete guide for modifying configurations and new features | +| **Architecture Guide** | [๐Ÿ—๏ธ View](en-US/architecture_guide.md) | [๐Ÿ—๏ธ ๆŸฅ็œ‹](zh-CN/architecture_guide.md) | System architecture and technical implementation | +| **Quick Start Guide** | [๐Ÿš€ View](en-US/quick_start_guide.md) | [๐Ÿš€ ๆŸฅ็œ‹](zh-CN/quick_start_guide.md) | 5-minute setup and usage tutorial | +| **Quick Reference** | [๐Ÿ“‹ View](en-US/quick_reference.md) | [๐Ÿ“‹ ๆŸฅ็œ‹](zh-CN/quick_reference.md) | Quick lookup for common modifications | +| **Prompt Templates** | [๐ŸŽฏ View](en-US/prompt_templates.md) | [๐ŸŽฏ ๆŸฅ็œ‹](zh-CN/prompt_templates.md) | Ready-to-use prompt templates | ## ๐Ÿ”ง Key Topics Covered @@ -102,17 +111,19 @@ Navigate to `zh-CN/` directory (local development) for: ### Version Control Policy - โœ… **Include**: `en-US/` directory and all English documentation -- ๐Ÿšซ **Exclude**: `zh-CN/` directory (configured in `.gitignore`) +- โœ… **Include**: `zh-CN/` directory and all Chinese documentation - โœ… **Include**: This README file for navigation +- ๐ŸŽฏ **Rationale**: Both language versions provide value to the global community ## ๐Ÿ“ Contributing When contributing to documentation: -1. **Update English docs** for features that should be shared with the community -2. **Keep Chinese docs local** for development and customization purposes +1. **Update English docs** for features that should be shared with the international community +2. **Update Chinese docs** for features that benefit Chinese-speaking users 3. **Maintain consistency** between language versions when possible 4. **Test all examples** before documenting them +5. **Consider localization** - some features may be more relevant to specific regions ## ๐Ÿ”— Related Resources