mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-01 15:03:57 +08:00
docs: enhance documentation with examples and fix package names
- Fix incorrect package names (@ccw/cli, @anthropic/claude-code-workflow) to claude-code-workflow - Add workflow examples page with 8 practical artifact samples - Optimize sidebar navigation with emoji icons and second-level grouping - Add usage examples to commands and skills documentation - Update qa/issues.md with current status - Sync Chinese documentation changes
This commit is contained in:
@@ -144,3 +144,48 @@ echo 'set -gx PATH (npm config get prefix)/bin $PATH' >> ~/.config/fish/config.f
|
||||
::: info Next Steps
|
||||
After installation, check out the [First Workflow](./first-workflow.md) guide.
|
||||
:::
|
||||
|
||||
## Quick Start Example
|
||||
|
||||
After installation, try these commands to verify everything works:
|
||||
|
||||
```bash
|
||||
# 1. Initialize in your project
|
||||
cd your-project
|
||||
ccw init
|
||||
|
||||
# 2. Try a simple analysis
|
||||
ccw cli -p "Analyze the project structure" --tool gemini --mode analysis
|
||||
|
||||
# 3. Run the main orchestrator
|
||||
/ccw "Summarize the codebase architecture"
|
||||
|
||||
# 4. Check available commands
|
||||
ccw --help
|
||||
```
|
||||
|
||||
### Expected Output
|
||||
|
||||
```
|
||||
$ ccw --version
|
||||
CCW v7.0.5
|
||||
|
||||
$ ccw init
|
||||
✔ Created .claude/CLAUDE.md
|
||||
✔ Created .ccw/workflows/
|
||||
✔ Configuration complete
|
||||
|
||||
$ ccw cli -p "Analyze project" --tool gemini --mode analysis
|
||||
Analyzing with Gemini...
|
||||
✔ Analysis complete
|
||||
```
|
||||
|
||||
### Common First-Time Issues
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| `ccw: command not found` | Add npm global bin to PATH, or reinstall |
|
||||
| `Permission denied` | Use `sudo` or fix npm permissions |
|
||||
| `API key not found` | Configure API keys in `~/.claude/cli-tools.json` |
|
||||
| `Node version mismatch` | Update to Node.js >= 18.0.0 |
|
||||
|
||||
|
||||
Reference in New Issue
Block a user