Skip to content

Commit 39bbf96

Browse files
author
catlog22
committed
feat(docs): update examples and enhance language support in configuration
1 parent 5e35da3 commit 39bbf96

2 files changed

Lines changed: 32 additions & 18 deletions

File tree

docs/.vitepress/config.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,14 +254,24 @@ export default defineConfig({
254254
},
255255
languages: [
256256
'bash',
257+
'shell',
257258
'powershell',
258259
'json',
259260
'yaml',
260261
'toml',
261262
'javascript',
262263
'typescript',
264+
'jsx',
265+
'tsx',
263266
'vue',
264-
'markdown'
267+
'html',
268+
'css',
269+
'markdown',
270+
'python',
271+
'ruby',
272+
'diff',
273+
'xml',
274+
'mermaid'
265275
],
266276
config: (md) => {
267277
// Add markdown-it plugins if needed

docs/workflows/examples.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This page provides practical examples of CCW workflow artifacts with sensitive information redacted.
44

5+
<div v-pre>
6+
57
## Example 1: Lite Plan Output
68

79
### plan.json
@@ -261,13 +263,13 @@ This is an output from `issue:execute` command.
261263
### review-report.md
262264
This is an output from `review-code` skill.
263265

264-
```markdown
266+
```text
265267
## Code Review Report
266268
267269
### Summary
268-
- **Review Type**: 6-Dimensional code review
269-
- **Scope**: All files changed in PR #42
270-
- **Timestamp**: 2026-02-28
270+
- Review Type: 6-Dimensional code review
271+
- Scope: All files changed in PR #42
272+
- Timestamp: 2026-02-28
271273
272274
### 1. Correctness
273275
| Aspect | Score | Issues |
@@ -291,9 +293,9 @@ This is an output from `review-code` skill.
291293
### Overall Score: 8.4/10
292294
293295
### Recommendations
294-
1. **Performance**: Review bundle size
295-
2. **Performance**: Optimize database queries
296-
3. **Maintainability**: Add JSDoc comments
296+
1. Performance: Review bundle size
297+
2. Performance: Optimize database queries
298+
3. Maintainability: Add JSDoc comments
297299
```
298300

299301
---
@@ -303,23 +305,23 @@ This is an output from `review-code` skill.
303305
### spec-section.md
304306
This is an output from `spec-generator` skill.
305307

306-
```markdown
308+
```text
307309
## API: User Authentication
308310
309311
### Endpoint: POST /api/auth/login
310-
- **Description**: Authenticate user with email and password
311-
- **Request**: { "email": "string", "password": "string" }
312-
- **Response**: { "success": true, "token": "jwt_token", "user": {...} }
312+
- Description: Authenticate user with email and password
313+
- Request: { "email": "string", "password": "string" }
314+
- Response: { "success": true, "token": "jwt_token", "user": {...} }
313315
314316
### Endpoint: POST /api/auth/oauth2/callback
315-
- **Description**: Handle OAuth2 provider callback
316-
- **Request**: { "code": "string", "provider": "string", "state": "string" }
317-
- **Response**: { "success": true, "token": "jwt_token", "user": {...} }
317+
- Description: Handle OAuth2 provider callback
318+
- Request: { "code": "string", "provider": "string", "state": "string" }
319+
- Response: { "success": true, "token": "jwt_token", "user": {...} }
318320
319321
### Endpoint: POST /api/auth/logout
320-
- **Description**: Logout user and invalidate token
321-
- **Headers**: Authorization: Bearer token
322-
- **Response**: { "success": true, "message": "Logged out" }
322+
- Description: Logout user and invalidate token
323+
- Headers: Authorization: Bearer token
324+
- Response: { "success": true, "message": "Logged out" }
323325
324326
### Error Codes
325327
| Code | Description |
@@ -375,6 +377,8 @@ examples:
375377
output: "Created auth-api.md with 5 endpoints"
376378
```
377379
380+
</div>
381+
378382
---
379383
380384
## Using These Examples

0 commit comments

Comments
 (0)