mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-03-01 15:03:57 +08:00
fix(docs): resolve VitePress build errors with custom HTML tags
- 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
This commit is contained in:
catlog22
2
.github/workflows/docs.yml
vendored
2
.github/workflows/docs.yml
vendored
@@ -53,7 +53,7 @@ jobs:
|
||||
path: docs/.vitepress/dist
|
||||
|
||||
deploy:
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && github.ref == 'refs/heads/main'
|
||||
environment:
|
||||
name: github-pages
|
||||
url: ${{ steps.deployment.outputs.page_url }}
|
||||
|
||||
@@ -76,11 +76,12 @@ export default defineConfig({
|
||||
}
|
||||
],
|
||||
|
||||
// Sidebar - 按照 Trellis 风格组织
|
||||
// Sidebar - 优化导航结构，增加二级标题和归类
|
||||
sidebar: {
|
||||
'/guide/': [
|
||||
{
|
||||
text: 'Guide',
|
||||
text: '📖 指南',
|
||||
collapsible: false,
|
||||
items: [
|
||||
{ text: 'What is Claude_dms3', link: '/guide/ch01-what-is-claude-dms3' },
|
||||
{ text: 'Getting Started', link: '/guide/ch02-getting-started' },
|
||||
@@ -89,11 +90,20 @@ export default defineConfig({
|
||||
{ text: 'Advanced Tips', link: '/guide/ch05-advanced-tips' },
|
||||
{ text: 'Best Practices', link: '/guide/ch06-best-practices' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '🚀 快速入口',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Installation', link: '/guide/installation' },
|
||||
{ text: 'First Workflow', link: '/guide/first-workflow' },
|
||||
{ text: 'CLI Tools', link: '/guide/cli-tools' }
|
||||
]
|
||||
}
|
||||
],
|
||||
'/commands/': [
|
||||
{
|
||||
text: 'Claude Commands',
|
||||
text: '🤖 Claude Commands',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Overview', link: '/commands/claude/' },
|
||||
@@ -107,7 +117,7 @@ export default defineConfig({
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Codex Prompts',
|
||||
text: '📝 Codex Prompts',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Overview', link: '/commands/codex/' },
|
||||
@@ -118,7 +128,7 @@ export default defineConfig({
|
||||
],
|
||||
'/skills/': [
|
||||
{
|
||||
text: 'Claude Skills',
|
||||
text: '⚡ Claude Skills',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Overview', link: '/skills/claude-index' },
|
||||
@@ -130,7 +140,7 @@ export default defineConfig({
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Codex Skills',
|
||||
text: '🔧 Codex Skills',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Overview', link: '/skills/codex-index' },
|
||||
@@ -138,17 +148,33 @@ export default defineConfig({
|
||||
{ text: 'Workflow', link: '/skills/codex-workflow' },
|
||||
{ text: 'Specialized', link: '/skills/codex-specialized' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '🎨 Custom Skills',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Overview', link: '/skills/custom' },
|
||||
{ text: 'Core Skills', link: '/skills/core-skills' },
|
||||
{ text: 'Reference', link: '/skills/reference' }
|
||||
]
|
||||
}
|
||||
],
|
||||
'/features/': [
|
||||
{
|
||||
text: 'Core Features',
|
||||
text: '⚙️ Core Features',
|
||||
collapsible: false,
|
||||
items: [
|
||||
{ text: 'Spec System', link: '/features/spec' },
|
||||
{ text: 'Memory System', link: '/features/memory' },
|
||||
{ text: 'CLI Call', link: '/features/cli' },
|
||||
{ text: 'Dashboard', link: '/features/dashboard' },
|
||||
{ text: 'CodexLens', link: '/features/codexlens' },
|
||||
{ text: 'CodexLens', link: '/features/codexlens' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '🔌 Settings',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'API Settings', link: '/features/api-settings' },
|
||||
{ text: 'System Settings', link: '/features/system-settings' }
|
||||
]
|
||||
@@ -156,7 +182,7 @@ export default defineConfig({
|
||||
],
|
||||
'/mcp/': [
|
||||
{
|
||||
text: 'MCP Tools',
|
||||
text: '🔗 MCP Tools',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Overview', link: '/mcp/tools' }
|
||||
@@ -165,7 +191,7 @@ export default defineConfig({
|
||||
],
|
||||
'/agents/': [
|
||||
{
|
||||
text: 'Agents',
|
||||
text: '🤖 Agents',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Overview', link: '/agents/' },
|
||||
@@ -176,12 +202,13 @@ export default defineConfig({
|
||||
],
|
||||
'/workflows/': [
|
||||
{
|
||||
text: 'Workflow System',
|
||||
text: '🔄 Workflow System',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'Overview', link: '/workflows/' },
|
||||
{ text: '4-Level System', link: '/workflows/4-level' },
|
||||
{ text: 'Best Practices', link: '/workflows/best-practices' }
|
||||
{ text: 'Best Practices', link: '/workflows/best-practices' },
|
||||
{ text: 'Teams', link: '/workflows/teams' }
|
||||
]
|
||||
}
|
||||
]
|
||||
@@ -259,7 +286,7 @@ export default defineConfig({
|
||||
nav: [
|
||||
{ text: '指南', link: '/zh/guide/ch01-what-is-claude-dms3' },
|
||||
{ text: '命令', link: '/zh/commands/claude/' },
|
||||
{ text: '技能', link: '/skills/' },
|
||||
{ text: '技能', link: '/zh/skills/claude-index' },
|
||||
{ text: '功能', link: '/zh/features/spec' },
|
||||
{
|
||||
text: '语言',
|
||||
@@ -271,7 +298,8 @@ export default defineConfig({
|
||||
sidebar: {
|
||||
'/zh/guide/': [
|
||||
{
|
||||
text: '指南',
|
||||
text: '📖 指南',
|
||||
collapsible: false,
|
||||
items: [
|
||||
{ text: 'Claude_dms3 是什么', link: '/zh/guide/ch01-what-is-claude-dms3' },
|
||||
{ text: '快速开始', link: '/zh/guide/ch02-getting-started' },
|
||||
@@ -280,11 +308,20 @@ export default defineConfig({
|
||||
{ text: '高级技巧', link: '/zh/guide/ch05-advanced-tips' },
|
||||
{ text: '最佳实践', link: '/zh/guide/ch06-best-practices' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '🚀 快速入口',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: '安装', link: '/zh/guide/installation' },
|
||||
{ text: '第一个工作流', link: '/zh/guide/first-workflow' },
|
||||
{ text: 'CLI 工具', link: '/zh/guide/cli-tools' }
|
||||
]
|
||||
}
|
||||
],
|
||||
'/zh/commands/': [
|
||||
{
|
||||
text: 'Claude 命令',
|
||||
text: '🤖 Claude 命令',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: '概述', link: '/zh/commands/claude/' },
|
||||
@@ -298,7 +335,7 @@ export default defineConfig({
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Codex Prompts',
|
||||
text: '📝 Codex Prompts',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: '概述', link: '/zh/commands/codex/' },
|
||||
@@ -309,7 +346,7 @@ export default defineConfig({
|
||||
],
|
||||
'/zh/skills/': [
|
||||
{
|
||||
text: 'Claude Skills',
|
||||
text: '⚡ Claude Skills',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: '概述', link: '/zh/skills/claude-index' },
|
||||
@@ -321,7 +358,7 @@ export default defineConfig({
|
||||
]
|
||||
},
|
||||
{
|
||||
text: 'Codex Skills',
|
||||
text: '🔧 Codex Skills',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: '概述', link: '/zh/skills/codex-index' },
|
||||
@@ -329,17 +366,33 @@ export default defineConfig({
|
||||
{ text: '工作流', link: '/zh/skills/codex-workflow' },
|
||||
{ text: '专项', link: '/zh/skills/codex-specialized' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '🎨 自定义技能',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: '概述', link: '/zh/skills/custom' },
|
||||
{ text: '核心技能', link: '/zh/skills/core-skills' },
|
||||
{ text: '参考', link: '/zh/skills/reference' }
|
||||
]
|
||||
}
|
||||
],
|
||||
'/zh/features/': [
|
||||
{
|
||||
text: '核心功能',
|
||||
text: '⚙️ 核心功能',
|
||||
collapsible: false,
|
||||
items: [
|
||||
{ text: 'Spec 规范系统', link: '/zh/features/spec' },
|
||||
{ text: 'Memory 记忆系统', link: '/zh/features/memory' },
|
||||
{ text: 'CLI 调用', link: '/zh/features/cli' },
|
||||
{ text: 'Dashboard 面板', link: '/zh/features/dashboard' },
|
||||
{ text: 'CodexLens', link: '/zh/features/codexlens' },
|
||||
{ text: 'CodexLens', link: '/zh/features/codexlens' }
|
||||
]
|
||||
},
|
||||
{
|
||||
text: '🔌 设置',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: 'API 设置', link: '/zh/features/api-settings' },
|
||||
{ text: '系统设置', link: '/zh/features/system-settings' }
|
||||
]
|
||||
@@ -347,12 +400,13 @@ export default defineConfig({
|
||||
],
|
||||
'/zh/workflows/': [
|
||||
{
|
||||
text: '工作流系统',
|
||||
text: '🔄 工作流系统',
|
||||
collapsible: true,
|
||||
items: [
|
||||
{ text: '概述', link: '/zh/workflows/' },
|
||||
{ text: '四级体系', link: '/zh/workflows/4-level' },
|
||||
{ text: '最佳实践', link: '/zh/workflows/best-practices' }
|
||||
{ text: '最佳实践', link: '/zh/workflows/best-practices' },
|
||||
{ text: '团队协作', link: '/zh/workflows/teams' }
|
||||
]
|
||||
}
|
||||
]
|
||||
|
||||
@@ -299,7 +299,7 @@ const content = {
|
||||
label: 'npm',
|
||||
lines: [
|
||||
{ type: 'comment', text: '# Install CCW globally' },
|
||||
{ type: 'cmd', text: 'npm install -g @anthropic/claude-code-workflow' },
|
||||
{ type: 'cmd', text: 'npm install -g claude-code-workflow' },
|
||||
{ type: 'output', text: 'added 1 package in 3s' },
|
||||
{ type: 'comment', text: '# Initialize in your project' },
|
||||
{ type: 'cmd', text: 'ccw init' },
|
||||
@@ -314,7 +314,7 @@ const content = {
|
||||
label: 'pnpm',
|
||||
lines: [
|
||||
{ type: 'comment', text: '# Install CCW globally' },
|
||||
{ type: 'cmd', text: 'pnpm add -g @anthropic/claude-code-workflow' },
|
||||
{ type: 'cmd', text: 'pnpm add -g claude-code-workflow' },
|
||||
{ type: 'output', text: 'Done in 2.1s' },
|
||||
{ type: 'comment', text: '# Initialize in your project' },
|
||||
{ type: 'cmd', text: 'ccw init' },
|
||||
@@ -372,7 +372,7 @@ const content = {
|
||||
label: 'npm',
|
||||
lines: [
|
||||
{ type: 'comment', text: '# 全局安装 CCW' },
|
||||
{ type: 'cmd', text: 'npm install -g @anthropic/claude-code-workflow' },
|
||||
{ type: 'cmd', text: 'npm install -g claude-code-workflow' },
|
||||
{ type: 'output', text: 'added 1 package in 3s' },
|
||||
{ type: 'comment', text: '# 在项目中初始化' },
|
||||
{ type: 'cmd', text: 'ccw init' },
|
||||
@@ -387,7 +387,7 @@ const content = {
|
||||
label: 'pnpm',
|
||||
lines: [
|
||||
{ type: 'comment', text: '# 全局安装 CCW' },
|
||||
{ type: 'cmd', text: 'pnpm add -g @anthropic/claude-code-workflow' },
|
||||
{ type: 'cmd', text: 'pnpm add -g claude-code-workflow' },
|
||||
{ type: 'output', text: 'Done in 2.1s' },
|
||||
{ type: 'comment', text: '# 在项目中初始化' },
|
||||
{ type: 'cmd', text: 'ccw init' },
|
||||
|
||||
@@ -19,7 +19,7 @@ CCW is a comprehensive development environment that combines:
|
||||
|
||||
```bash
|
||||
# Install CCW globally
|
||||
npm install -g @ccw/cli
|
||||
npm install -g claude-code-workflow
|
||||
|
||||
# Or use with npx
|
||||
npx ccw --help
|
||||
@@ -48,7 +48,7 @@ Create a simple workflow in under 5 minutes:
|
||||
|
||||
- [Installation Guide](./installation.md) - Detailed installation instructions
|
||||
- [First Workflow](./first-workflow.md) - 30-minute quickstart tutorial
|
||||
- [Configuration](./configuration.md) - Customize your CCW setup
|
||||
- [CLI Tools](./cli-tools.md) - Customize your CCW setup
|
||||
|
||||
::: tip Need Help?
|
||||
Check out our [GitHub Discussions](https://github.com/your-repo/ccw/discussions) or join our [Discord community](https://discord.gg/ccw).
|
||||
|
||||
@@ -15,14 +15,14 @@ Before installing CCW, make sure you have:
|
||||
### Global Installation (Recommended)
|
||||
|
||||
```bash
|
||||
npm install -g @ccw/cli
|
||||
npm install -g claude-code-workflow
|
||||
```
|
||||
|
||||
### Project-Specific Installation
|
||||
|
||||
```bash
|
||||
# In your project directory
|
||||
npm install --save-dev @ccw/cli
|
||||
npm install --save-dev claude-code-workflow
|
||||
|
||||
# Run with npx
|
||||
npx ccw [command]
|
||||
@@ -32,10 +32,10 @@ npx ccw [command]
|
||||
|
||||
```bash
|
||||
# Global
|
||||
yarn global add @ccw/cli
|
||||
yarn global add claude-code-workflow
|
||||
|
||||
# Project-specific
|
||||
yarn add -D @ccw/cli
|
||||
yarn add -D claude-code-workflow
|
||||
```
|
||||
|
||||
## Verify Installation
|
||||
@@ -98,16 +98,16 @@ Create `CLAUDE.md` in your project root:
|
||||
|
||||
```bash
|
||||
# Update to the latest version
|
||||
npm update -g @ccw/cli
|
||||
npm update -g claude-code-workflow
|
||||
|
||||
# Or install a specific version
|
||||
npm install -g @ccw/cli@latest
|
||||
npm install -g claude-code-workflow@latest
|
||||
```
|
||||
|
||||
## Uninstallation
|
||||
|
||||
```bash
|
||||
npm uninstall -g @ccw/cli
|
||||
npm uninstall -g claude-code-workflow
|
||||
|
||||
# Remove configuration (optional)
|
||||
rm -rf ~/.claude
|
||||
@@ -121,7 +121,7 @@ If you encounter permission errors:
|
||||
|
||||
```bash
|
||||
# Use sudo (not recommended)
|
||||
sudo npm install -g @ccw/cli
|
||||
sudo npm install -g claude-code-workflow
|
||||
|
||||
# Or fix npm permissions (recommended)
|
||||
mkdir ~/.npm-global
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# CCW Documentation Site - Known Issues
|
||||
|
||||
**Generated**: 2026-02-27
|
||||
**Generated**: 2026-02-28
|
||||
**Status**: Active Tracking
|
||||
|
||||
## Summary
|
||||
@@ -9,8 +9,8 @@
|
||||
|----------|-------|--------|
|
||||
| Critical | 0 | All Fixed |
|
||||
| High | 0 | - |
|
||||
| Medium | 2 | Open |
|
||||
| Low | 5 | Suppressed |
|
||||
| Medium | 1 | Open |
|
||||
| Low | 2 | Suppressed |
|
||||
|
||||
---
|
||||
|
||||
@@ -41,56 +41,51 @@
|
||||
- **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)
|
||||
|
||||
### #4 - Missing Documentation Pages
|
||||
### #5 - Missing Chinese Documentation Pages
|
||||
- **Severity**: Medium
|
||||
- **Status**: Open
|
||||
- **Description**: 7 documentation pages referenced but not created
|
||||
- **Affected Links**:
|
||||
- `/guide/first-workflow` (referenced in getting-started.md)
|
||||
- `/guide/configuration` (referenced in getting-started.md)
|
||||
- `/skills/development` (referenced in core-skills.md)
|
||||
- **Status**: Partially Fixed
|
||||
- **Description**: Some Chinese documentation pages are missing
|
||||
- **Still Missing**:
|
||||
- `/zh/guide/first-workflow`
|
||||
- `/zh/guide/configuration`
|
||||
- `/zh/guide/cli-tools`
|
||||
- `/zh/skills/core-skills`
|
||||
|
||||
**Impact**: Users clicking these links will see 404 pages
|
||||
|
||||
**Recommendation**: Create stub pages or update references
|
||||
|
||||
### #5 - vue-i18n Deprecation Warning
|
||||
- **Severity**: Medium
|
||||
- **Status**: Open
|
||||
- **Description**: vue-i18n v10 is deprecated, v9 and v10 no longer supported
|
||||
- **Message**: "v9 and v10 no longer supported. please migrate to v11"
|
||||
- **Impact**: Future compatibility risk
|
||||
|
||||
**Recommendation**: Plan migration to vue-i18n v11
|
||||
**Recommendation**: Create Chinese translations or use VitePress i18n fallback
|
||||
|
||||
---
|
||||
|
||||
## Low Issues (Suppressed)
|
||||
|
||||
### #6-12 - Dead Links (Non-Blocking)
|
||||
### #6 - Dead Links (Non-Blocking)
|
||||
- **Severity**: Low
|
||||
- **Status**: Suppressed via `ignoreDeadLinks: true`
|
||||
- **Description**: Same 7 dead links from #4, now ignored at build time
|
||||
|
||||
**Note**: These are tracked in #4 but listed separately for completeness
|
||||
- **Description**: Links to missing Chinese pages
|
||||
- **Note**: These are tracked in #5 but suppressed at build time
|
||||
|
||||
---
|
||||
|
||||
## Content Quality Observations
|
||||
|
||||
### Potential Improvements
|
||||
1. **Breadcrumb component exists but may not be integrated** - Check if breadcrumbs are rendering
|
||||
2. **CopyCodeButton component exists** - Verify code blocks have copy buttons
|
||||
3. **DarkModeToggle exists** - Verify theme switching works
|
||||
4. **ThemeSwitcher/ColorSchemeSelector** - Color theming may need testing in browser
|
||||
### 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)
|
||||
@@ -108,5 +103,5 @@
|
||||
| #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 | Missing Docs Pages | 2026-02-27 | - | Open |
|
||||
| #5 | vue-i18n Deprecation | 2026-02-27 | - | Open |
|
||||
| #4 | Incorrect Package Name | 2026-02-28 | 2026-02-28 | Updated package name |
|
||||
| #5 | Missing Chinese Docs | 2026-02-27 | - | Partial - some still missing |
|
||||
|
||||
@@ -15,14 +15,14 @@
|
||||
### 全局安装（推荐）
|
||||
|
||||
```bash
|
||||
npm install -g @ccw/cli
|
||||
npm install -g claude-code-workflow
|
||||
```
|
||||
|
||||
### 项目特定安装
|
||||
|
||||
```bash
|
||||
# 在您的项目目录中
|
||||
npm install --save-dev @ccw/cli
|
||||
npm install --save-dev claude-code-workflow
|
||||
|
||||
# 使用 npx 运行
|
||||
npx ccw [命令]
|
||||
@@ -32,10 +32,10 @@ npx ccw [命令]
|
||||
|
||||
```bash
|
||||
# 全局
|
||||
yarn global add @ccw/cli
|
||||
yarn global add claude-code-workflow
|
||||
|
||||
# 项目特定
|
||||
yarn add -D @ccw/cli
|
||||
yarn add -D claude-code-workflow
|
||||
```
|
||||
|
||||
## 验证安装
|
||||
@@ -98,16 +98,16 @@ ccw --help
|
||||
|
||||
```bash
|
||||
# 更新到最新版本
|
||||
npm update -g @ccw/cli
|
||||
npm update -g claude-code-workflow
|
||||
|
||||
# 或安装特定版本
|
||||
npm install -g @ccw/cli@latest
|
||||
npm install -g claude-code-workflow@latest
|
||||
```
|
||||
|
||||
## 卸载
|
||||
|
||||
```bash
|
||||
npm uninstall -g @ccw/cli
|
||||
npm uninstall -g claude-code-workflow
|
||||
|
||||
# 删除配置（可选）
|
||||
rm -rf ~/.claude
|
||||
|
||||
Reference in New Issue
Block a user