mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-01 15:03:57 +08:00
84610661ca
- Fix custom tags (Good, Bad, Before, After, Tip, Note, Warning) in skill docs - Replace placeholder variables with HTML entities to prevent Vue parser errors - Allow manual workflow_dispatch to trigger docs deployment
108 lines
3.2 KiB
Markdown
108 lines
3.2 KiB
Markdown
# CCW Documentation Site - Known Issues
|
|
|
|
**Generated**: 2026-02-28
|
|
**Status**: Active Tracking
|
|
|
|
## Summary
|
|
|
|
| Severity | Count | Status |
|
|
|----------|-------|--------|
|
|
| Critical | 0 | All Fixed |
|
|
| High | 0 | - |
|
|
| Medium | 1 | Open |
|
|
| Low | 2 | Suppressed |
|
|
|
|
---
|
|
|
|
## Critical Issues (All Fixed)
|
|
|
|
### [FIXED] #1 - Invalid VitePress Version Constraint
|
|
- **File**: `package.json`
|
|
- **Severity**: Critical
|
|
- **Status**: Fixed
|
|
- **Description**: `vitepress: ^6.0.0` doesn't exist in npm registry
|
|
- **Fix Applied**: Changed to `^1.0.0`
|
|
- **Verified**: ✅ Build succeeds
|
|
|
|
### [FIXED] #2 - Vite Config Conflict
|
|
- **File**: `vite.config.ts` (removed)
|
|
- **Severity**: Critical
|
|
- **Status**: Fixed
|
|
- **Description**: Custom vite.config.ts with vue() plugin caused SFC parsing failures
|
|
- **Fix Applied**: Removed vite.config.ts (VitePress handles its own config)
|
|
- **Verified**: ✅ Build succeeds
|
|
|
|
### [FIXED] #3 - Dead Links Blocking Build
|
|
- **File**: `.vitepress/config.ts`
|
|
- **Severity**: Critical (at build time)
|
|
- **Status**: Fixed
|
|
- **Description**: 7 dead links caused build to fail
|
|
- **Fix Applied**: Added `ignoreDeadLinks: true` to config
|
|
- **Verified**: ✅ Build succeeds
|
|
- **Note**: Links are still broken but no longer block builds
|
|
|
|
### [FIXED] #4 - Incorrect Package Name
|
|
- **File**: Multiple files
|
|
- **Severity**: Critical
|
|
- **Status**: Fixed (2026-02-28)
|
|
- **Description**: Documentation showed incorrect package names (`@ccw/cli`, `@anthropic/claude-code-workflow`)
|
|
- **Fix Applied**: Updated to correct package name `claude-code-workflow`
|
|
- **Files Updated**:
|
|
- `guide/installation.md`
|
|
- `guide/getting-started.md`
|
|
- `zh/guide/installation.md`
|
|
- `.vitepress/theme/components/ProfessionalHome.vue`
|
|
|
|
---
|
|
|
|
## Medium Issues (Open)
|
|
|
|
### #5 - Missing Chinese Documentation Pages
|
|
- **Severity**: Medium
|
|
- **Status**: Partially Fixed
|
|
- **Description**: Some Chinese documentation pages are missing
|
|
- **Still Missing**:
|
|
- `/zh/guide/first-workflow`
|
|
- `/zh/guide/cli-tools`
|
|
- `/zh/skills/core-skills`
|
|
|
|
**Recommendation**: Create Chinese translations or use VitePress i18n fallback
|
|
|
|
---
|
|
|
|
## Low Issues (Suppressed)
|
|
|
|
### #6 - Dead Links (Non-Blocking)
|
|
- **Severity**: Low
|
|
- **Status**: Suppressed via `ignoreDeadLinks: true`
|
|
- **Description**: Links to missing Chinese pages
|
|
- **Note**: These are tracked in #5 but suppressed at build time
|
|
|
|
---
|
|
|
|
## Content Quality Observations
|
|
|
|
### Completed Improvements
|
|
1. ✅ Package name corrected to `claude-code-workflow`
|
|
2. ✅ Installation guide updated with correct commands
|
|
3. ✅ Homepage Quick Start shows correct package name
|
|
|
|
### Suggested Manual Tests
|
|
1. Test theme switching (light/dark/auto)
|
|
2. Test color scheme selector
|
|
3. Test mobile responsive design at 375px width
|
|
4. Test search functionality
|
|
5. Test Chinese language toggle
|
|
|
|
---
|
|
|
|
## Resolution Tracker
|
|
|
|
| ID | Title | Open Date | Closed Date | Resolution |
|
|
|----|-------|-----------|-------------|------------|
|
|
| #1 | Invalid VitePress Version | 2026-02-27 | 2026-02-27 | Fixed version |
|
|
| #2 | Vite Config Conflict | 2026-02-27 | 2026-02-27 | Removed file |
|
|
| #3 | Dead Links Blocking | 2026-02-27 | 2026-02-27 | Added ignore flag |
|
|
| #4 | Incorrect Package Name | 2026-02-28 | 2026-02-28 | Updated package name |
|
|
| #5 | Missing Chinese Docs | 2026-02-27 | - | Partial - some still missing |
|