thanh-kit 2.5.2 โ†’ 2.5.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/dist/index.js +30 -0
  2. package/dist/index.js.map +1 -1
  3. package/package.json +1 -1
  4. package/templates/.env.example +100 -0
  5. package/templates/commands/bootstrap/auto/fast.md +111 -0
  6. package/templates/commands/bootstrap/auto/parallel.md +66 -0
  7. package/templates/commands/bootstrap/auto.md +115 -0
  8. package/templates/commands/bootstrap.md +137 -0
  9. package/templates/commands/code/auto.md +203 -0
  10. package/templates/commands/code/no-test.md +174 -0
  11. package/templates/commands/code/parallel.md +100 -0
  12. package/templates/commands/code.md +205 -0
  13. package/templates/commands/content/cro.md +43 -0
  14. package/templates/commands/content/enhance.md +14 -0
  15. package/templates/commands/content/fast.md +13 -0
  16. package/templates/commands/content/good.md +16 -0
  17. package/templates/commands/cook/auto/fast.md +26 -0
  18. package/templates/commands/cook/auto/parallel.md +49 -0
  19. package/templates/commands/cook/auto.md +15 -0
  20. package/templates/commands/cook.md +105 -0
  21. package/templates/commands/debug.md +13 -0
  22. package/templates/commands/design/3d.md +83 -0
  23. package/templates/commands/design/describe.md +23 -0
  24. package/templates/commands/design/fast.md +31 -0
  25. package/templates/commands/design/good.md +35 -0
  26. package/templates/commands/design/screenshot.md +34 -0
  27. package/templates/commands/design/video.md +34 -0
  28. package/templates/commands/fix/ci.md +17 -0
  29. package/templates/commands/fix/fast.md +19 -0
  30. package/templates/commands/fix/hard.md +39 -0
  31. package/templates/commands/fix/logs.md +26 -0
  32. package/templates/commands/fix/parallel.md +54 -0
  33. package/templates/commands/fix/test.md +20 -0
  34. package/templates/commands/fix/types.md +9 -0
  35. package/templates/commands/fix/ui.md +48 -0
  36. package/templates/commands/fix.md +43 -0
  37. package/templates/commands/plan/ci.md +33 -0
  38. package/templates/commands/plan/cro.md +69 -0
  39. package/templates/commands/plan/fast.md +82 -0
  40. package/templates/commands/plan/hard.md +108 -0
  41. package/templates/commands/plan/parallel.md +145 -0
  42. package/templates/commands/plan/two.md +45 -0
  43. package/templates/commands/plan.md +30 -0
  44. package/templates/commands/scout/ext.md +39 -0
  45. package/templates/commands/scout.md +28 -0
  46. package/templates/commands/skill/add.md +36 -0
  47. package/templates/commands/skill/create.md +29 -0
  48. package/templates/commands/skill/fix-logs.md +22 -0
  49. package/templates/commands/skill/optimize/auto.md +25 -0
  50. package/templates/commands/skill/optimize.md +34 -0
  51. package/templates/commands/skill/update.md +36 -0
  52. package/templates/skills/.env.example +1 -0
  53. package/templates/statusline.cjs +0 -0
  54. package/templates/statusline.sh +0 -0
  55. package/templates/AGENTS.md +0 -104
  56. package/templates/README.md +0 -241
  57. package/templates/command-archive/ask.md +0 -56
  58. package/templates/command-archive/ck-help.md +0 -129
  59. package/templates/command-archive/coding-level.md +0 -48
  60. package/templates/command-archive/docs/init.md +0 -38
  61. package/templates/command-archive/docs/summarize.md +0 -22
  62. package/templates/command-archive/docs/update.md +0 -76
  63. package/templates/command-archive/journal.md +0 -18
  64. package/templates/command-archive/kanban.md +0 -99
  65. package/templates/command-archive/plan/archive.md +0 -57
  66. package/templates/command-archive/plan/red-team.md +0 -200
  67. package/templates/command-archive/plan/validate.md +0 -188
  68. package/templates/command-archive/preview.md +0 -283
  69. package/templates/command-archive/review/codebase/parallel.md +0 -122
  70. package/templates/command-archive/review/codebase.md +0 -49
  71. package/templates/command-archive/test/ui.md +0 -92
  72. package/templates/command-archive/test.md +0 -8
  73. package/templates/command-archive/use-mcp.md +0 -38
  74. package/templates/command-archive/watzup.md +0 -8
  75. package/templates/command-archive/worktree.md +0 -109
  76. package/templates/discord/README.md +0 -274
  77. package/templates/discord/config.json5 +0 -87
  78. package/templates/discord/skills/auto-intent-router/SKILL.md +0 -195
  79. package/templates/discord/skills/train-prompt/SKILL.md +0 -306
  80. package/templates/discord/start-bot.sh +0 -47
  81. package/templates/gemini/settings.json +0 -12
@@ -1,241 +0,0 @@
1
- # ๐Ÿ  .claude - AI Control Center
2
-
3
- ## What is .claude?
4
-
5
- The **`.claude`** directory is the "extended brain" of the AI - containing all configurations, knowledge, and processes that enable the AI to work smarter and more professionally.
6
-
7
- **Simple Example:**
8
- - Without `.claude`: The AI responds like a standard chatbot.
9
- - With `.claude`: The AI operates as a full team of specialized experts.
10
-
11
- ---
12
-
13
- ## Overview Structure
14
-
15
- ```
16
- .claude/
17
- โ”‚
18
- โ”œโ”€โ”€ ๐Ÿค– agents/ โ† ROLES (Who does it?)
19
- โ”‚ โ””โ”€โ”€ 17 distinct expert personas
20
- โ”‚
21
- โ”œโ”€โ”€ ๐Ÿ“‹ commands/ โ† PROCEDURES (How is it done?)
22
- โ”‚ โ””โ”€โ”€ 50+ standardized workflows
23
- โ”‚
24
- โ”œโ”€โ”€ ๐Ÿ“š skills/ โ† KNOWLEDGE (What to know?)
25
- โ”‚ โ””โ”€โ”€ 59 domain-specific knowledge bases
26
- โ”‚
27
- โ”œโ”€โ”€ ๐Ÿงญ router/ โ† ROUTING (What to choose?)
28
- โ”‚ โ””โ”€โ”€ 5 decision-making guides
29
- โ”‚
30
- โ”œโ”€โ”€ ๐Ÿ”„ workflows/ โ† ORCHESTRATION (Big tasks)
31
- โ”‚ โ””โ”€โ”€ 4 collaboration scenarios
32
- โ”‚
33
- โ”œโ”€โ”€ โšก hooks/ โ† AUTOMATION (Trigger events)
34
- โ”‚ โ””โ”€โ”€ 15+ automated scripts
35
- โ”‚
36
- โ”œโ”€โ”€ ๐Ÿ”ง scripts/ โ† UTILITIES (Tools)
37
- โ”‚ โ””โ”€โ”€ 10+ helper scripts
38
- โ”‚
39
- โ””โ”€โ”€ โš™๏ธ settings.json โ† CONFIG (Customization)
40
- ```
41
-
42
- ---
43
-
44
- ## Directory Explanation
45
-
46
- ### ๐Ÿค– agents/ - Expert Roles
47
-
48
- **What it is:** 17 different "personas" the AI can embody.
49
-
50
- **Examples:**
51
- | You say | AI embodies |
52
- |---------|-------------|
53
- | "Fix bug" | Debugger (Bug Hunter) |
54
- | "Write code" | Developer (Programmer) |
55
- | "Make a plan" | Planner (Architect) |
56
-
57
- ๐Ÿ“– [See details in agents/README.md](agents/README.md)
58
-
59
- ---
60
-
61
- ### ๐Ÿ“‹ commands/ - Workflows
62
-
63
- **What it is:** 50+ step-by-step "recipes" for specific tasks.
64
-
65
- **Examples:**
66
- | Command | Action |
67
- |---------|--------|
68
- | `/fix` | Standard 5-step bug fix |
69
- | `/code` | Coding workflow with testing |
70
- | `/plan` | Planning template |
71
-
72
- ๐Ÿ“– [See details in commands/README.md](commands/README.md)
73
-
74
- ---
75
-
76
- ### ๐Ÿ“š skills/ - Specialized Knowledge
77
-
78
- **What it is:** 59 knowledge packages loaded on demand.
79
-
80
- **Examples:**
81
- | Skill | Contains |
82
- |-------|----------|
83
- | `ui-ux-pro-max` | 50 styles, 21 palettes, 50 fonts |
84
- | `debugging` | 4-step debug framework |
85
- | `better-auth` | OAuth, 2FA guides |
86
-
87
- ๐Ÿ“– [See details in skills/README.md](skills/README.md)
88
-
89
- ---
90
-
91
- ### ๐Ÿงญ router/ - Decision Engine
92
-
93
- **What it is:** The "decision brain" - helps AI select the right agent/command/skill.
94
-
95
- **How it works:**
96
- ```
97
- You: "Fix login error"
98
- โ†“
99
- Router analyzes keywords
100
- โ†“
101
- Selects: Debugger + /fix + better-auth
102
- โ†“
103
- AI starts working
104
- ```
105
-
106
- ๐Ÿ“– [See details in router/README.md](router/README.md)
107
-
108
- ---
109
-
110
- ### ๐Ÿ”„ workflows/ - Multi-step Collaboration
111
-
112
- **What it is:** Scripts for large tasks requiring coordination.
113
-
114
- **Example:** New Feature
115
- ```
116
- Planner โ†’ Developer โ†’ Tester โ†’ Reviewer โ†’ Docs Manager
117
- ```
118
-
119
- ๐Ÿ“– [See details in workflows/README.md](workflows/README.md)
120
-
121
- ---
122
-
123
- ### โšก hooks/ - Automation
124
-
125
- **What it is:** Code that runs automatically on events.
126
-
127
- **Examples:**
128
- | Event | Hook runs |
129
- |-------|-----------|
130
- | File edit | Auto-format (Prettier) |
131
- | Task done | Auto-review |
132
- | Session start | Auto-load context |
133
-
134
- ๐Ÿ“– [See details in hooks/README.md](hooks/README.md)
135
-
136
- ---
137
-
138
- ### ๐Ÿ”ง scripts/ - Utility Tools
139
-
140
- **What it is:** Helper scripts.
141
-
142
- **Examples:**
143
- | Script | Action |
144
- |--------|--------|
145
- | `scan_skills.py` | Scans and generates skills list |
146
- | `worktree.cjs` | Manages git worktrees |
147
- | `ck-help.py` | Command lookup |
148
-
149
- ๐Ÿ“– [See details in scripts/README.md](scripts/README.md)
150
-
151
- ---
152
-
153
- ## How It All Works Together
154
-
155
- ### Example: "Add dark mode to app"
156
-
157
- ```
158
- STEP 1: Router Analysis
159
- โ”œโ”€โ”€ Keywords: "add", "dark mode"
160
- โ”œโ”€โ”€ Task Type: New Feature
161
- โ””โ”€โ”€ Complexity: Medium
162
-
163
- STEP 2: Resource Selection
164
- โ”œโ”€โ”€ Agents: planner โ†’ developer โ†’ tester
165
- โ”œโ”€โ”€ Commands: /plan โ†’ /code โ†’ /test
166
- โ”œโ”€โ”€ Skills: ui-ux-pro-max, frontend-development
167
- โ””โ”€โ”€ Workflow: primary-workflow
168
-
169
- STEP 3: Execution
170
- โ”œโ”€โ”€ Planner creates plan
171
- โ”œโ”€โ”€ Developer writes code
172
- โ”œโ”€โ”€ Tester writes tests
173
- โ””โ”€โ”€ Hooks auto-format & review
174
-
175
- STEP 4: Completion
176
- โ”œโ”€โ”€ Code merged
177
- โ”œโ”€โ”€ Docs updated (automated)
178
- โ””โ”€โ”€ Changelog recorded (automated)
179
- ```
180
-
181
- ---
182
-
183
- ## Quick Reference
184
-
185
- | Need | Look in |
186
- |------|---------|
187
- | Who does the work | `agents/` |
188
- | What process to follow | `commands/` |
189
- | What knowledge is needed | `skills/` |
190
- | How AI decides | `router/` |
191
- | Large multi-step tasks | `workflows/` |
192
- | Automation | `hooks/` |
193
- | Utility tools | `scripts/` |
194
-
195
- ---
196
-
197
- ## Configuration Files
198
-
199
- | File | Function |
200
- |------|----------|
201
- | `settings.json` | General config |
202
- | `.env` | Environment variables (do not commit) |
203
- | `.env.example` | Env var template |
204
- | `.mcp.json.example` | MCP server config |
205
- | `.gitignore` | Ignored files |
206
-
207
- ---
208
-
209
- ## Summary
210
-
211
- | Directory | Count | Function |
212
- |-----------|-------|----------|
213
- | agents | 17 | Expert Roles |
214
- | commands | 50+ | Workflows |
215
- | skills | 59 | Specialized Knowledge |
216
- | router | 5 | Decision Routing |
217
- | workflows | 4 | Orchestration |
218
- | hooks | 15+ | Automation |
219
- | scripts | 10+ | Utilities |
220
-
221
- ---
222
-
223
- ## Where to Start?
224
-
225
- ### If you are new:
226
- 1. Read [agents/README.md](agents/README.md) - Understand roles
227
- 2. Read [commands/README.md](commands/README.md) - Understand workflows
228
- 3. Try simple requests
229
-
230
- ### If you want to customize:
231
- 1. See [skills/README.md](skills/README.md) - Create custom skills
232
- 2. See [hooks/README.md](hooks/README.md) - Add automation
233
- 3. See [router/README.md](router/README.md) - Understand decision logic
234
-
235
- ---
236
-
237
- ## Quick Links
238
-
239
- - [๐Ÿ“– AGENTS.md](../AGENTS.md) - Core Ruleset
240
- - [๐Ÿ“– README.md](../README.md) - Project Overview
241
- - [๐Ÿ”ง Settings](settings.json) - Configuration
@@ -1,56 +0,0 @@
1
- ---
2
- description: โšก Answer technical and architectural questions.
3
- argument-hint: [technical-question]
4
- ---
5
-
6
- ## Context
7
- Technical question or architecture challenge:
8
- <questions>$ARGUMENTS</questions>
9
-
10
- Current development workflows, system constraints, scale requirements, and business context will be considered:
11
- - Primary workflow: `./.claude/rules/primary-workflow.md`
12
- - Development rules: `./.claude/rules/development-rules.md`
13
- - Orchestration protocols: `./.claude/rules/orchestration-protocol.md`
14
- - Documentation management: `./.claude/rules/documentation-management.md`
15
-
16
- **Project Documentation:**
17
- ```
18
- ./docs
19
- โ”œโ”€โ”€ project-overview-pdr.md
20
- โ”œโ”€โ”€ code-standards.md
21
- โ”œโ”€โ”€ codebase-summary.md
22
- โ”œโ”€โ”€ design-guidelines.md
23
- โ”œโ”€โ”€ deployment-guide.md
24
- โ”œโ”€โ”€ system-architecture.md
25
- โ””โ”€โ”€ project-roadmap.md
26
- ```
27
-
28
- ## Your Role
29
- You are a Senior Systems Architect providing expert consultation and architectural guidance. You focus on high-level design, strategic decisions, and architectural patterns rather than implementation details. You orchestrate four specialized architectural advisors:
30
- 1. **Systems Designer** โ€“ evaluates system boundaries, interfaces, and component interactions.
31
- 2. **Technology Strategist** โ€“ recommends technology stacks, frameworks, and architectural patterns.
32
- 3. **Scalability Consultant** โ€“ assesses performance, reliability, and growth considerations.
33
- 4. **Risk Analyst** โ€“ identifies potential issues, trade-offs, and mitigation strategies.
34
- You operate by the holy trinity of software engineering: **YAGNI** (You Aren't Gonna Need It), **KISS** (Keep It Simple, Stupid), and **DRY** (Don't Repeat Yourself). Every solution you propose must honor these principles.
35
-
36
- ## Process
37
- 1. **Problem Understanding**: Analyze the technical question and gather architectural context.
38
- - If the architecture context doesn't contain the necessary information, use the `scout` skill to scout the codebase again.
39
- 2. **Expert Consultation**:
40
- - Systems Designer: Define system boundaries, data flows, and component relationships
41
- - Technology Strategist: Evaluate technology choices, patterns, and industry best practices
42
- - Scalability Consultant: Assess non-functional requirements and scalability implications
43
- - Risk Analyst: Identify architectural risks, dependencies, and decision trade-offs
44
- 3. **Architecture Synthesis**: Combine insights to provide comprehensive architectural guidance.
45
- 4. **Strategic Validation**: Ensure recommendations align with business goals and technical constraints.
46
-
47
- ## Output Format
48
- **Be honest, be brutal, straight to the point, and be concise.**
49
- 1. **Architecture Analysis** โ€“ comprehensive breakdown of the technical challenge and context.
50
- 2. **Design Recommendations** โ€“ high-level architectural solutions with rationale and alternatives.
51
- 3. **Technology Guidance** โ€“ strategic technology choices with pros/cons analysis.
52
- 4. **Implementation Strategy** โ€“ phased approach and architectural decision framework.
53
- 5. **Next Actions** โ€“ strategic next steps, proof-of-concepts, and architectural validation points.
54
-
55
- ## Important
56
- This command focuses on architectural consultation and strategic guidance. Do not start implementing anything.
@@ -1,129 +0,0 @@
1
- ---
2
- description: ClaudeKit usage guide - just type naturally
3
- argument-hint: [category|command|task description]
4
- ---
5
-
6
- Think harder.
7
- All-in-one ClaudeKit guide. Run the script and present output based on type markers.
8
-
9
- ## Intent Validation
10
-
11
- The script uses keyword matching with smart weighting. After getting results, **validate** against these heuristics:
12
-
13
- | Sentence Pattern | Primary Intent | Example |
14
- |------------------|----------------|---------|
15
- | `[action verb] my [object]` | The action verb | "commit my changes" โ†’ git |
16
- | `[context] [subject noun]` | The subject noun | "setup notifications" โ†’ notifications |
17
- | `[noun] [noun]` | Last noun (topic) | "discord webhook" โ†’ notifications |
18
-
19
- **Action verbs** (high intent when first): fix, test, commit, push, build, create, review, deploy, run, check, find, plan, refactor
20
-
21
- **Context words** (low intent, modify subject): setup, add, start, new, my, the, configure
22
-
23
- **Override script only if:** result clearly mismatches the sentence pattern above. Otherwise trust the algorithm.
24
-
25
- ## Translation
26
-
27
- **IMPORTANT: Always translate `$ARGUMENTS` to English before passing to script.**
28
-
29
- The Python script only understands English keywords. If `$ARGUMENTS` is in another language:
30
- 1. Translate `$ARGUMENTS` to English
31
- 2. Pass the translated English string to the script
32
-
33
- ## Execution
34
-
35
- ```bash
36
- python .claude/scripts/ck-help.py "$ARGUMENTS"
37
- ```
38
-
39
- ## Output Type Detection
40
-
41
- The script outputs a type marker on the first line: `@CK_OUTPUT_TYPE:<type>`
42
-
43
- **Read this marker and adjust your presentation accordingly:**
44
-
45
- ### `@CK_OUTPUT_TYPE:comprehensive-docs`
46
-
47
- Full documentation (config, schema, setup guides).
48
-
49
- **Presentation:**
50
- 1. Show the **COMPLETE** script output verbatim - every section, every code block
51
- 2. **THEN ADD** helpful context:
52
- - Real-world usage examples ("For example, if you're working on multiple projects...")
53
- - Common gotchas and tips ("Watch out for: ...")
54
- - Practical scenarios ("This is useful when...")
55
- 3. End with a specific follow-up question
56
-
57
- **Example enhancement after showing full output:**
58
- ```
59
- ## Additional Tips
60
-
61
- **When to use global vs local config:**
62
- - Use global (~/.claude/.ck.json) for personal preferences like language, issue prefix style
63
- - Use local (./.claude/.ck.json) for project-specific paths, naming conventions
64
-
65
- **Common setup for teams:**
66
- Each team member sets their locale globally, but projects share local config via git.
67
-
68
- Need help setting up a specific configuration?
69
- ```
70
-
71
- ### `@CK_OUTPUT_TYPE:category-guide`
72
-
73
- Workflow guides for command categories (fix, plan, cook, etc.).
74
-
75
- **Presentation:**
76
- 1. Show the complete workflow and command list
77
- 2. **ADD** practical context:
78
- - When to use this workflow vs alternatives
79
- - Real example: "If you encounter a bug in authentication, start with..."
80
- - Transition tips between commands
81
- 3. Offer to help with a specific task
82
-
83
- ### `@CK_OUTPUT_TYPE:command-details`
84
-
85
- Single command documentation.
86
-
87
- **Presentation:**
88
- 1. Show full command info from script
89
- 2. **ADD**:
90
- - Concrete usage example with realistic input
91
- - When this command shines vs alternatives
92
- - Common flags or variations
93
- 3. Offer to run the command for them
94
-
95
- ### `@CK_OUTPUT_TYPE:search-results`
96
-
97
- Search matches for a keyword.
98
-
99
- **Presentation:**
100
- 1. Show all matches from script
101
- 2. **HELP** user navigate:
102
- - Group by relevance if many results
103
- - Suggest most likely match based on context
104
- - Offer to explain any specific command
105
- 3. Ask what they're trying to accomplish
106
-
107
- ### `@CK_OUTPUT_TYPE:task-recommendations`
108
-
109
- Task-based command suggestions.
110
-
111
- **Presentation:**
112
- 1. Show recommended commands from script
113
- 2. **EXPLAIN** the reasoning:
114
- - Why these commands fit the task
115
- - Suggested order of execution
116
- - What each step accomplishes
117
- 3. Offer to start with the first recommended command
118
-
119
- ## Key Principle
120
-
121
- **Script output = foundation. Your additions = value-add.**
122
-
123
- Never replace or summarize the script output. Always show it fully, then enhance with your knowledge and context.
124
-
125
- ## Important: Correct Workflows
126
-
127
- - **`/plan` โ†’ `/cook`**: Plan first, then execute the plan
128
- - **`/cook`**: Standalone - plans internally, no separate `/plan` needed
129
- - **NEVER** suggest `/plan` โ†’ `/cook` (cook has its own planning)
@@ -1,48 +0,0 @@
1
- Set your coding experience level for tailored explanations and output format.
2
-
3
- ## Usage
4
-
5
- `/coding-level [0-5]`
6
-
7
- ## Levels
8
-
9
- | Level | Name | Description |
10
- |-------|------|-------------|
11
- | 0 | ELI5 | Zero coding experience - analogies, no jargon, step-by-step |
12
- | 1 | Junior | 0-2 years - concepts explained, WHY not just HOW |
13
- | 2 | Mid-Level | 3-5 years - design patterns, system thinking |
14
- | 3 | Senior | 5-8 years - trade-offs, business context, architecture |
15
- | 4 | Tech Lead | 8-10 years - risk assessment, business impact, strategy |
16
- | 5 | God Mode | Expert - default behavior, maximum efficiency (default) |
17
-
18
- ## How It Works
19
-
20
- 1. Set `codingLevel` in `.claude/.ck.json`
21
- 2. Guidelines are **automatically injected** on every session start
22
- 3. No manual activation needed - it just works!
23
-
24
- ## Example
25
-
26
- Set level 1 in `.claude/.ck.json`:
27
- ```json
28
- {
29
- "codingLevel": 1,
30
- ...
31
- }
32
- ```
33
-
34
- Next session, Claude will automatically:
35
- - Explain concepts and techniques clearly
36
- - Always explain WHY, not just HOW
37
- - Point out common mistakes
38
- - Add "Key Takeaways" after implementations
39
-
40
- ## Optional: Manual Output Styles
41
-
42
- For finer control, you can also use `/output-style` with these styles:
43
- - `coding-level-0-eli5`
44
- - `coding-level-1-junior`
45
- - `coding-level-2-mid`
46
- - `coding-level-3-senior`
47
- - `coding-level-4-lead`
48
- - `coding-level-5-god`
@@ -1,38 +0,0 @@
1
- ---
2
- description: โšกโšกโšกโšก Analyze the codebase and create initial documentation
3
- ---
4
-
5
- ## Phase 1: Parallel Codebase Scouting
6
-
7
- 1. Scan the codebase and calculate the number of files with LOC in each directory (skip credentials, cache or external modules directories, such as `.claude`, `.opencode`, `.git`, `tests`, `node_modules`, `__pycache__`, `secrets`, etc.)
8
- 2. Target directories **that actually exist** - adapt to project structure, don't hardcode paths
9
- 3. Activate `scout` skill to explore the code base and return detailed summary reports to the main agent
10
- 4. Merge scout reports into context summary
11
-
12
- ## Phase 2: Documentation Creation (docs-manager Agent)
13
-
14
- **CRITICAL:** You MUST spawn `docs-manager` agent via Task tool with merged reports. Do not wait for user input.
15
-
16
- Pass the gathered context to docs-manager agent to create initial documentation:
17
- - `README.md`: Update README with initial documentation (keep it under 300 lines)
18
- - `docs/project-overview-pdr.md`: Project overview and PDR (Product Development Requirements)
19
- - `docs/codebase-summary.md`: Codebase summary
20
- - `docs/code-standards.md`: Codebase structure and code standards
21
- - `docs/system-architecture.md`: System architecture
22
- - `docs/project-roadmap.md`: Project roadmap
23
- - `docs/deployment-guide.md` [optional]: Deployment guide
24
- - `docs/design-guidelines.md` [optional]: Design guidelines
25
-
26
- Use `docs/` directory as the source of truth for documentation.
27
-
28
- ## Phase 3: Size Check (Post-Generation)
29
-
30
- After docs-manager completes:
31
- 1. Run `wc -l docs/*.md 2>/dev/null | sort -rn` to check LOC
32
- 2. Use `docs.maxLoc` from session context (default: 800)
33
- 3. For files exceeding limit:
34
- - Report which files exceed and by how much
35
- - docs-manager should have already split proactively per Section 6 guidelines
36
- - If still oversized, ask user: split now or accept as-is?
37
-
38
- **IMPORTANT**: **Do not** start implementing.
@@ -1,22 +0,0 @@
1
- ---
2
- description: 'โšก Analyze the codebase and update documentation'
3
- argument-hint: '[focused-topics] [should-scan-codebase]'
4
- ---
5
-
6
- Activate `scout` skill to analyze the codebase and update `docs/codebase-summary.md` and respond with a summary report.
7
-
8
- ## Arguments:
9
- $1: Focused topics (default: all)
10
- $2: Should scan codebase (`Boolean`, default: `false`)
11
-
12
- ## Focused Topics:
13
- <focused_topics>$1</focused_topics>
14
-
15
- ## Should Scan Codebase:
16
- <should_scan_codebase>$2</should_scan_codebase>
17
-
18
- ## Important:
19
- - Use `docs/` directory as the source of truth for documentation.
20
- - Do not scan the entire codebase unless the user explicitly requests it.
21
-
22
- **IMPORTANT**: **Do not** start implementing.
@@ -1,76 +0,0 @@
1
- ---
2
- description: โšกโšกโšก Analyze the codebase and update documentation
3
- ---
4
-
5
- ## Phase 1: Parallel Codebase Scouting
6
-
7
- 1. Scan the codebase and calculate the number of files with LOC in each directory (skip credentials, cache or external modules directories, such as `.claude`, `.opencode`, `.git`, `tests`, `node_modules`, `__pycache__`, `secrets`, etc.)
8
- 2. Target directories **that actually exist** - adapt to project structure, don't hardcode paths
9
- 3. Activate `scout` skill to explore the code base and return detailed summary reports to the main agent
10
- 4. Merge scout reports into context summary
11
-
12
- ## Phase 1.5: Parallel Documentation Reading
13
-
14
- **You (main agent) must spawn readers** - subagents cannot spawn subagents.
15
-
16
- 1. Count docs: `ls docs/*.md 2>/dev/null | wc -l`
17
- 2. Get LOC: `wc -l docs/*.md 2>/dev/null | sort -rn`
18
- 3. Strategy:
19
- - 1-3 files: Skip parallel reading, docs-manager reads directly
20
- - 4-6 files: Spawn 2-3 `Explore` agents
21
- - 7+ files: Spawn 4-5 `Explore` agents (max 5)
22
- 4. Distribute files by LOC (larger files get dedicated agent)
23
- 5. Each agent prompt: "Read these docs, extract: purpose, key sections, areas needing update. Files: {list}"
24
- 6. Merge results into context for docs-manager
25
-
26
- ### Workload Distribution Example
27
-
28
- | Agent | Files | Est. LOC |
29
- |-------|-------|----------|
30
- | 1 | codebase-summary.md (800) | 800 |
31
- | 2 | system-architecture.md (400), code-standards.md (300) | 700 |
32
- | 3 | project-overview-pdr.md (500), project-roadmap.md (200) | 700 |
33
-
34
- ## Phase 2: Documentation Update (docs-manager Agent)
35
-
36
- **CRITICAL:** You MUST spawn `docs-manager` agent via Task tool with merged reports and doc readings. Do not wait for user input.
37
-
38
- Pass the gathered context to docs-manager agent to update documentation:
39
- - `README.md`: Update README (keep it under 300 lines)
40
- - `docs/project-overview-pdr.md`: Update project overview and PDR (Product Development Requirements)
41
- - `docs/codebase-summary.md`: Update codebase summary
42
- - `docs/code-standards.md`: Update codebase structure and code standards
43
- - `docs/system-architecture.md`: Update system architecture
44
- - `docs/project-roadmap.md`: Update project roadmap
45
- - `docs/deployment-guide.md` [optional]: Update deployment guide
46
- - `docs/design-guidelines.md` [optional]: Update design guidelines
47
-
48
- ## Additional requests
49
- <additional_requests>
50
- $ARGUMENTS
51
- </additional_requests>
52
-
53
- ## Phase 3: Size Check (Post-Update)
54
-
55
- After docs-manager completes:
56
- 1. Run `wc -l docs/*.md 2>/dev/null | sort -rn` to check LOC
57
- 2. Use `docs.maxLoc` from session context (default: 800)
58
- 3. For files exceeding limit:
59
- - Report which files exceed and by how much
60
- - docs-manager should have already split proactively per Section 6 guidelines
61
- - If still oversized, ask user: split now or accept as-is?
62
-
63
- ## Phase 4: Documentation Validation (Post-Update)
64
-
65
- Run validation to detect potential hallucinations:
66
- 1. Run: `node .claude/scripts/validate-docs.cjs docs/`
67
- 2. Display validation report (warnings only, non-blocking)
68
- 3. Checks performed:
69
- - Code references: Verify `functionName()` and `ClassName` exist in codebase
70
- - Internal links: Verify `[text](./path.md)` links point to existing files
71
- - Config keys: Verify `ENV_VAR` mentioned in docs exist in `.env.example`
72
-
73
- ## Important
74
- - Use `docs/` directory as the source of truth for documentation.
75
-
76
- **IMPORTANT**: **Do not** start implementing.
@@ -1,18 +0,0 @@
1
- ---
2
- description: โšก Write some journal entries.
3
- ---
4
-
5
- ## Writing Style Detection
6
-
7
- Before writing, check for a writing-styles directory:
8
- 1. Check `docs/writing-styles/` โ€” if exists, read all `.md` files inside
9
- 2. Check `assets/writing-styles/` โ€” if exists and step 1 not found, read all `.md` files inside
10
- 3. If writing styles found โ†’ adopt tone, vocabulary, sentence structure, and formatting rules from those files
11
- 4. If no writing-styles directory found โ†’ write freely in a natural, conversational tone
12
-
13
- ## Journal Writing
14
-
15
- Use the `journal-writer` subagent to explore the memories and recent code changes, and write journal entries.
16
- - Concise, focused on important events, key changes, impacts, and decisions
17
- - Apply detected writing style (if any) to the journal voice
18
- - Keep journal entries in `docs/journal/` directory