Generated system design and usage examples documentation based on project
context and provided templates.
ARCHITECTURE.md provides an overview of the system's architecture,
including core principles, structure, module map, interactions, design patterns,
API overview, data flow, security, and scalability.
EXAMPLES.md offers end-to-end usage examples, covering quick start, core use cases,
advanced scenarios, testing examples, and best practices.
The /workflow:ui-design:imitate-auto command no longer supports URL input.
Updated all documentation to reflect that it now only accepts:
- Local image files (glob patterns)
- Local code files/directories
- Text prompts
Changes:
- COMMAND_SPEC.md: Updated syntax and examples
- WORKFLOW_DECISION_GUIDE.md/.._EN.md: Replaced URL examples with local file examples
- EXAMPLES.md: Updated design system creation example
- GETTING_STARTED.md/.._CN.md: Fixed command descriptions
- ui-design-workflow-guide.md: Updated multiple sections and examples
Note: layout-extract still supports --urls parameter (not changed)
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
