mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
docs: add comprehensive project documentation
Add four new comprehensive documentation files and update READMEs: New Documentation: - ARCHITECTURE.md: High-level system architecture overview * Design philosophy and core principles * System components and data flow * Multi-agent system details * CLI tool integration strategy * Session and memory management * Performance optimizations and best practices - CONTRIBUTING.md: Contributor guidelines * Code of conduct * Development setup instructions * Coding standards and best practices * Testing guidelines * Documentation requirements * Pull request process * Release process - FAQ.md: Frequently asked questions * General questions about CCW * Installation and setup * Usage and workflows * Commands and syntax * Sessions and tasks * Agents and tools * Memory system * Troubleshooting * Advanced topics - EXAMPLES.md: Real-world use cases * Quick start examples * Web development (Express, React, e-commerce) * API development (REST, GraphQL) * Testing & quality assurance (TDD, test generation) * Refactoring (monolith to microservices) * UI/UX design (design systems, landing pages) * Bug fixes (simple and complex) * Documentation generation * DevOps & automation (CI/CD, Docker) * Complex projects (chat app, analytics dashboard) Updated Documentation: - README.md: Added comprehensive documentation section * Organized docs into categories * Links to all new documentation files * Improved navigation structure - README_CN.md: Added documentation section (Chinese) * Same organization as English version * Links to all documentation resources Benefits: - Provides clear entry points for new users - Comprehensive reference for all features - Real-world examples for practical learning - Complete contributor onboarding - Better project discoverability
This commit is contained in:
27
README_CN.md
27
README_CN.md
@@ -159,11 +159,38 @@ CCW 包含内置的**命令指南技能**,帮助您有效地发现和使用命
|
||||
|
||||
---
|
||||
|
||||
## 📚 文档
|
||||
|
||||
CCW 提供全面的文档,帮助您快速上手并掌握高级功能:
|
||||
|
||||
### 📖 **快速入门**
|
||||
- [**快速上手指南**](GETTING_STARTED_CN.md) - 5 分钟快速入门教程
|
||||
- [**安装指南**](INSTALL_CN.md) - 详细安装说明 ([English](INSTALL.md))
|
||||
- [**示例**](EXAMPLES.md) - 真实世界用例和实践示例 (English)
|
||||
- [**常见问题**](FAQ.md) - 常见问题和故障排除 (English)
|
||||
|
||||
### 🏗️ **架构与设计**
|
||||
- [**架构概览**](ARCHITECTURE.md) - 系统设计和核心组件 (English)
|
||||
- [**项目介绍**](PROJECT_INTRODUCTION.md) - 详细项目概览
|
||||
- [**工作流图示**](WORKFLOW_DIAGRAMS.md) - 可视化工作流表示 (English)
|
||||
|
||||
### 📋 **命令参考**
|
||||
- [**命令参考**](COMMAND_REFERENCE.md) - 所有命令的完整列表 (English)
|
||||
- [**命令规范**](COMMAND_SPEC.md) - 详细技术规范 (English)
|
||||
- [**命令流程标准**](COMMAND_FLOW_STANDARD.md) - 命令设计模式 (English)
|
||||
|
||||
### 🤝 **贡献**
|
||||
- [**贡献指南**](CONTRIBUTING.md) - 如何为 CCW 做贡献 (English)
|
||||
- [**更新日志**](CHANGELOG.md) - 版本历史和发布说明
|
||||
|
||||
---
|
||||
|
||||
## 🤝 贡献与支持
|
||||
|
||||
- **仓库**: [GitHub - Claude-Code-Workflow](https://github.com/catlog22/Claude-Code-Workflow)
|
||||
- **问题**: 在 [GitHub Issues](https://github.com/catlog22/Claude-Code-Workflow/issues) 上报告错误或请求功能。
|
||||
- **讨论**: 加入 [社区论坛](https://github.com/catlog22/Claude-Code-Workflow/discussions)。
|
||||
- **贡献**: 查看 [CONTRIBUTING.md](CONTRIBUTING.md) 了解贡献指南。
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
|
||||
Reference in New Issue
Block a user