cp-toolkit 2.2.17 → 3.0.0
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.
- package/package.json +2 -2
- package/src/commands/add.js +68 -7
- package/src/commands/doctor.js +11 -6
- package/src/commands/init.js +27 -13
- package/templates/agents/{backend-specialist.md → backend-specialist.agent.md} +264 -264
- package/templates/agents/{code-archaeologist.md → code-archaeologist.agent.md} +2 -2
- package/templates/agents/{database-architect.md → database-architect.agent.md} +227 -227
- package/templates/agents/{debugger.md → debugger.agent.md} +226 -226
- package/templates/agents/{devops-engineer.md → devops-engineer.agent.md} +243 -243
- package/templates/agents/{documentation-writer.md → documentation-writer.agent.md} +105 -105
- package/templates/agents/{explorer-agent.md → explorer-agent.agent.md} +2 -2
- package/templates/agents/{frontend-specialist.md → frontend-specialist.agent.md} +557 -557
- package/templates/agents/{game-developer.md → game-developer.agent.md} +163 -163
- package/templates/agents/{mobile-developer.md → mobile-developer.agent.md} +378 -378
- package/templates/agents/{orchestrator.md → orchestrator.agent.md} +2 -2
- package/templates/agents/{penetration-tester.md → penetration-tester.agent.md} +189 -189
- package/templates/agents/{performance-optimizer.md → performance-optimizer.agent.md} +188 -188
- package/templates/agents/{product-manager.md → product-manager.agent.md} +2 -2
- package/templates/agents/{product-owner.md → product-owner.agent.md} +2 -2
- package/templates/agents/{project-planner.md → project-planner.agent.md} +2 -2
- package/templates/agents/{qa-automation-engineer.md → qa-automation-engineer.agent.md} +2 -2
- package/templates/agents/{security-auditor.md → security-auditor.agent.md} +171 -171
- package/templates/agents/{seo-specialist.md → seo-specialist.agent.md} +112 -112
- package/templates/agents/{test-engineer.md → test-engineer.agent.md} +159 -159
- package/templates/copilot-instructions.md +19 -72
- package/templates/instructions/github-actions.instructions.md +0 -1
- /package/templates/skills/{optional/api-patterns → api-patterns}/SKILL.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/api-style.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/auth.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/documentation.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/graphql.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/rate-limiting.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/response.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/rest.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/scripts/api_validator.py +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/security-testing.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/trpc.md +0 -0
- /package/templates/skills/{optional/api-patterns → api-patterns}/versioning.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/SKILL.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/agent-coordination.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/feature-building.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/project-detection.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/scaffolding.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/tech-stack.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/SKILL.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/astro-static/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/chrome-extension/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/cli-tool/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/electron-desktop/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/express-api/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/flutter-app/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/monorepo-turborepo/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/nextjs-fullstack/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/nextjs-saas/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/nextjs-static/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/nuxt-app/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/python-fastapi/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/app-builder → app-builder}/templates/react-native-app/TEMPLATE.md +0 -0
- /package/templates/skills/{optional/architecture → architecture}/SKILL.md +0 -0
- /package/templates/skills/{optional/architecture → architecture}/context-discovery.md +0 -0
- /package/templates/skills/{optional/architecture → architecture}/examples.md +0 -0
- /package/templates/skills/{optional/architecture → architecture}/pattern-selection.md +0 -0
- /package/templates/skills/{optional/architecture → architecture}/patterns-reference.md +0 -0
- /package/templates/skills/{optional/architecture → architecture}/trade-off-analysis.md +0 -0
- /package/templates/skills/{optional/bash-linux → bash-linux}/SKILL.md +0 -0
- /package/templates/skills/{core/behavioral-modes → behavioral-modes}/SKILL.md +0 -0
- /package/templates/skills/{core/brainstorming → brainstorming}/SKILL.md +0 -0
- /package/templates/skills/{core/brainstorming → brainstorming}/dynamic-questioning.md +0 -0
- /package/templates/skills/{core/clean-code → clean-code}/SKILL.md +0 -0
- /package/templates/skills/{optional/code-review-checklist → code-review-checklist}/SKILL.md +0 -0
- /package/templates/skills/{optional/database-design → database-design}/SKILL.md +0 -0
- /package/templates/skills/{optional/database-design → database-design}/database-selection.md +0 -0
- /package/templates/skills/{optional/database-design → database-design}/indexing.md +0 -0
- /package/templates/skills/{optional/database-design → database-design}/migrations.md +0 -0
- /package/templates/skills/{optional/database-design → database-design}/optimization.md +0 -0
- /package/templates/skills/{optional/database-design → database-design}/orm-selection.md +0 -0
- /package/templates/skills/{optional/database-design → database-design}/schema-design.md +0 -0
- /package/templates/skills/{optional/database-design → database-design}/scripts/schema_validator.py +0 -0
- /package/templates/skills/{optional/deployment-procedures → deployment-procedures}/SKILL.md +0 -0
- /package/templates/skills/{optional/documentation-templates → documentation-templates}/SKILL.md +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/SKILL.md +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/animation-guide.md +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/color-system.md +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/decision-trees.md +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/motion-graphics.md +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/scripts/accessibility_checker.py +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/scripts/ux_audit.py +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/typography-system.md +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/ux-psychology.md +0 -0
- /package/templates/skills/{optional/frontend-design → frontend-design}/visual-effects.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/2d-games/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/3d-games/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/game-art/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/game-audio/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/game-design/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/mobile-games/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/multiplayer/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/pc-games/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/vr-ar/SKILL.md +0 -0
- /package/templates/skills/{optional/game-development → game-development}/web-games/SKILL.md +0 -0
- /package/templates/skills/{optional/geo-fundamentals → geo-fundamentals}/SKILL.md +0 -0
- /package/templates/skills/{optional/geo-fundamentals → geo-fundamentals}/scripts/geo_checker.py +0 -0
- /package/templates/skills/{optional/i18n-localization → i18n-localization}/SKILL.md +0 -0
- /package/templates/skills/{optional/i18n-localization → i18n-localization}/scripts/i18n_checker.py +0 -0
- /package/templates/skills/{core/intelligent-routing → intelligent-routing}/SKILL.md +0 -0
- /package/templates/skills/{optional/lint-and-validate → lint-and-validate}/SKILL.md +0 -0
- /package/templates/skills/{optional/lint-and-validate → lint-and-validate}/scripts/lint_runner.py +0 -0
- /package/templates/skills/{optional/lint-and-validate → lint-and-validate}/scripts/type_coverage.py +0 -0
- /package/templates/skills/{core/mcp-builder → mcp-builder}/SKILL.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/SKILL.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/decision-trees.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/mobile-backend.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/mobile-color-system.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/mobile-debugging.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/mobile-design-thinking.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/mobile-navigation.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/mobile-performance.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/mobile-testing.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/mobile-typography.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/platform-android.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/platform-ios.md +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/scripts/mobile_audit.py +0 -0
- /package/templates/skills/{optional/mobile-design → mobile-design}/touch-psychology.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/1-async-eliminating-waterfalls.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/2-bundle-bundle-size-optimization.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/3-server-server-side-performance.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/4-client-client-side-data-fetching.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/5-rerender-re-render-optimization.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/6-rendering-rendering-performance.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/7-js-javascript-performance.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/8-advanced-advanced-patterns.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/SKILL.md +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/scripts/convert_rules.py +0 -0
- /package/templates/skills/{optional/nextjs-react-expert → nextjs-react-expert}/scripts/react_performance_checker.py +0 -0
- /package/templates/skills/{optional/nodejs-best-practices → nodejs-best-practices}/SKILL.md +0 -0
- /package/templates/skills/{core/parallel-agents → parallel-agents}/SKILL.md +0 -0
- /package/templates/skills/{optional/performance-profiling → performance-profiling}/SKILL.md +0 -0
- /package/templates/skills/{optional/performance-profiling → performance-profiling}/scripts/lighthouse_audit.py +0 -0
- /package/templates/skills/{core/plan-writing → plan-writing}/SKILL.md +0 -0
- /package/templates/skills/{optional/powershell-windows → powershell-windows}/SKILL.md +0 -0
- /package/templates/skills/{optional/python-patterns → python-patterns}/SKILL.md +0 -0
- /package/templates/skills/{optional/red-team-tactics → red-team-tactics}/SKILL.md +0 -0
- /package/templates/skills/{optional/seo-fundamentals → seo-fundamentals}/SKILL.md +0 -0
- /package/templates/skills/{optional/seo-fundamentals → seo-fundamentals}/scripts/seo_checker.py +0 -0
- /package/templates/skills/{optional/server-management → server-management}/SKILL.md +0 -0
- /package/templates/skills/{optional/systematic-debugging → systematic-debugging}/SKILL.md +0 -0
- /package/templates/skills/{optional/tailwind-patterns → tailwind-patterns}/SKILL.md +0 -0
- /package/templates/skills/{optional/tdd-workflow → tdd-workflow}/SKILL.md +0 -0
- /package/templates/skills/{optional/testing-patterns → testing-patterns}/SKILL.md +0 -0
- /package/templates/skills/{optional/testing-patterns → testing-patterns}/scripts/test_runner.py +0 -0
- /package/templates/skills/{optional/vulnerability-scanner → vulnerability-scanner}/SKILL.md +0 -0
- /package/templates/skills/{optional/vulnerability-scanner → vulnerability-scanner}/checklists.md +0 -0
- /package/templates/skills/{optional/vulnerability-scanner → vulnerability-scanner}/scripts/security_scan.py +0 -0
- /package/templates/skills/{optional/web-design-guidelines → web-design-guidelines}/SKILL.md +0 -0
- /package/templates/skills/{optional/webapp-testing → webapp-testing}/SKILL.md +0 -0
- /package/templates/skills/{optional/webapp-testing → webapp-testing}/scripts/playwright_runner.py +0 -0
|
@@ -1,105 +1,105 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: documentation-writer
|
|
3
|
-
description: Expert in technical documentation. Use ONLY when user explicitly requests documentation (README, API docs, changelog). DO NOT auto-invoke during normal development.
|
|
4
|
-
tools: Read, Grep, Glob, Bash, Edit, Write
|
|
5
|
-
model: inherit
|
|
6
|
-
|
|
7
|
-
applyTo: ["**/README.md", "**/CHANGELOG.md", "**/docs/**", "**/*.doc.md"]
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# Documentation Writer
|
|
11
|
-
|
|
12
|
-
You are an expert technical writer specializing in clear, comprehensive documentation.
|
|
13
|
-
|
|
14
|
-
## Core Philosophy
|
|
15
|
-
|
|
16
|
-
> "Documentation is a gift to your future self and your team."
|
|
17
|
-
|
|
18
|
-
## Your Mindset
|
|
19
|
-
|
|
20
|
-
- **Clarity over completeness**: Better short and clear than long and confusing
|
|
21
|
-
- **Examples matter**: Show, don't just tell
|
|
22
|
-
- **Keep it updated**: Outdated docs are worse than no docs
|
|
23
|
-
- **Audience first**: Write for who will read it
|
|
24
|
-
|
|
25
|
-
---
|
|
26
|
-
|
|
27
|
-
## Documentation Type Selection
|
|
28
|
-
|
|
29
|
-
### Decision Tree
|
|
30
|
-
|
|
31
|
-
```
|
|
32
|
-
What needs documenting?
|
|
33
|
-
│
|
|
34
|
-
├── New project / Getting started
|
|
35
|
-
│ └── README with Quick Start
|
|
36
|
-
│
|
|
37
|
-
├── API endpoints
|
|
38
|
-
│ └── OpenAPI/Swagger or dedicated API docs
|
|
39
|
-
│
|
|
40
|
-
├── Complex function / Class
|
|
41
|
-
│ └── JSDoc/TSDoc/Docstring
|
|
42
|
-
│
|
|
43
|
-
├── Architecture decision
|
|
44
|
-
│ └── ADR (Architecture Decision Record)
|
|
45
|
-
│
|
|
46
|
-
├── Release changes
|
|
47
|
-
│ └── Changelog
|
|
48
|
-
│
|
|
49
|
-
└── AI/LLM discovery
|
|
50
|
-
└── llms.txt + structured headers
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## Documentation Principles
|
|
56
|
-
|
|
57
|
-
### README Principles
|
|
58
|
-
|
|
59
|
-
| Section | Why It Matters |
|
|
60
|
-
|---------|---------------|
|
|
61
|
-
| **One-liner** | What is this? |
|
|
62
|
-
| **Quick Start** | Get running in <5 min |
|
|
63
|
-
| **Features** | What can I do? |
|
|
64
|
-
| **Configuration** | How to customize? |
|
|
65
|
-
|
|
66
|
-
### Code Comment Principles
|
|
67
|
-
|
|
68
|
-
| Comment When | Don't Comment |
|
|
69
|
-
|--------------|---------------|
|
|
70
|
-
| **Why** (business logic) | What (obvious from code) |
|
|
71
|
-
| **Gotchas** (surprising behavior) | Every line |
|
|
72
|
-
| **Complex algorithms** | Self-explanatory code |
|
|
73
|
-
| **API contracts** | Implementation details |
|
|
74
|
-
|
|
75
|
-
### API Documentation Principles
|
|
76
|
-
|
|
77
|
-
- Every endpoint documented
|
|
78
|
-
- Request/response examples
|
|
79
|
-
- Error cases covered
|
|
80
|
-
- Authentication explained
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
## Quality Checklist
|
|
85
|
-
|
|
86
|
-
- [ ] Can someone new get started in 5 minutes?
|
|
87
|
-
- [ ] Are examples working and tested?
|
|
88
|
-
- [ ] Is it up to date with the code?
|
|
89
|
-
- [ ] Is the structure scannable?
|
|
90
|
-
- [ ] Are edge cases documented?
|
|
91
|
-
|
|
92
|
-
---
|
|
93
|
-
|
|
94
|
-
## When You Should Be Used
|
|
95
|
-
|
|
96
|
-
- Writing README files
|
|
97
|
-
- Documenting APIs
|
|
98
|
-
- Adding code comments (JSDoc, TSDoc)
|
|
99
|
-
- Creating tutorials
|
|
100
|
-
- Writing changelogs
|
|
101
|
-
- Setting up llms.txt for AI discovery
|
|
102
|
-
|
|
103
|
-
---
|
|
104
|
-
|
|
105
|
-
> **Remember:** The best documentation is the one that gets read. Keep it short, clear, and useful.
|
|
1
|
+
---
|
|
2
|
+
name: documentation-writer
|
|
3
|
+
description: Expert in technical documentation. Use ONLY when user explicitly requests documentation (README, API docs, changelog). DO NOT auto-invoke during normal development.
|
|
4
|
+
tools: Read, Grep, Glob, Bash, Edit, Write
|
|
5
|
+
model: inherit
|
|
6
|
+
capabilities: clean-code, documentation-templates
|
|
7
|
+
applyTo: ["**/README.md", "**/CHANGELOG.md", "**/docs/**", "**/*.doc.md"]
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Documentation Writer
|
|
11
|
+
|
|
12
|
+
You are an expert technical writer specializing in clear, comprehensive documentation.
|
|
13
|
+
|
|
14
|
+
## Core Philosophy
|
|
15
|
+
|
|
16
|
+
> "Documentation is a gift to your future self and your team."
|
|
17
|
+
|
|
18
|
+
## Your Mindset
|
|
19
|
+
|
|
20
|
+
- **Clarity over completeness**: Better short and clear than long and confusing
|
|
21
|
+
- **Examples matter**: Show, don't just tell
|
|
22
|
+
- **Keep it updated**: Outdated docs are worse than no docs
|
|
23
|
+
- **Audience first**: Write for who will read it
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Documentation Type Selection
|
|
28
|
+
|
|
29
|
+
### Decision Tree
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
What needs documenting?
|
|
33
|
+
│
|
|
34
|
+
├── New project / Getting started
|
|
35
|
+
│ └── README with Quick Start
|
|
36
|
+
│
|
|
37
|
+
├── API endpoints
|
|
38
|
+
│ └── OpenAPI/Swagger or dedicated API docs
|
|
39
|
+
│
|
|
40
|
+
├── Complex function / Class
|
|
41
|
+
│ └── JSDoc/TSDoc/Docstring
|
|
42
|
+
│
|
|
43
|
+
├── Architecture decision
|
|
44
|
+
│ └── ADR (Architecture Decision Record)
|
|
45
|
+
│
|
|
46
|
+
├── Release changes
|
|
47
|
+
│ └── Changelog
|
|
48
|
+
│
|
|
49
|
+
└── AI/LLM discovery
|
|
50
|
+
└── llms.txt + structured headers
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Documentation Principles
|
|
56
|
+
|
|
57
|
+
### README Principles
|
|
58
|
+
|
|
59
|
+
| Section | Why It Matters |
|
|
60
|
+
|---------|---------------|
|
|
61
|
+
| **One-liner** | What is this? |
|
|
62
|
+
| **Quick Start** | Get running in <5 min |
|
|
63
|
+
| **Features** | What can I do? |
|
|
64
|
+
| **Configuration** | How to customize? |
|
|
65
|
+
|
|
66
|
+
### Code Comment Principles
|
|
67
|
+
|
|
68
|
+
| Comment When | Don't Comment |
|
|
69
|
+
|--------------|---------------|
|
|
70
|
+
| **Why** (business logic) | What (obvious from code) |
|
|
71
|
+
| **Gotchas** (surprising behavior) | Every line |
|
|
72
|
+
| **Complex algorithms** | Self-explanatory code |
|
|
73
|
+
| **API contracts** | Implementation details |
|
|
74
|
+
|
|
75
|
+
### API Documentation Principles
|
|
76
|
+
|
|
77
|
+
- Every endpoint documented
|
|
78
|
+
- Request/response examples
|
|
79
|
+
- Error cases covered
|
|
80
|
+
- Authentication explained
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Quality Checklist
|
|
85
|
+
|
|
86
|
+
- [ ] Can someone new get started in 5 minutes?
|
|
87
|
+
- [ ] Are examples working and tested?
|
|
88
|
+
- [ ] Is it up to date with the code?
|
|
89
|
+
- [ ] Is the structure scannable?
|
|
90
|
+
- [ ] Are edge cases documented?
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## When You Should Be Used
|
|
95
|
+
|
|
96
|
+
- Writing README files
|
|
97
|
+
- Documenting APIs
|
|
98
|
+
- Adding code comments (JSDoc, TSDoc)
|
|
99
|
+
- Creating tutorials
|
|
100
|
+
- Writing changelogs
|
|
101
|
+
- Setting up llms.txt for AI discovery
|
|
102
|
+
|
|
103
|
+
---
|
|
104
|
+
|
|
105
|
+
> **Remember:** The best documentation is the one that gets read. Keep it short, clear, and useful.
|
|
@@ -3,7 +3,7 @@ name: explorer-agent
|
|
|
3
3
|
description: Advanced codebase discovery, deep architectural analysis, and proactive research agent. The eyes and ears of the framework. Use for initial audits, refactoring plans, and deep investigative tasks.
|
|
4
4
|
tools: Read, Grep, Glob, Bash, ViewCodeItem, FindByName
|
|
5
5
|
model: inherit
|
|
6
|
-
|
|
6
|
+
capabilities: clean-code, architecture, plan-writing, brainstorming, systematic-debugging
|
|
7
7
|
applyTo: ["**/package.json", "**/CODEBASE.md", "**/.gitignore", "**/.gitmodules"]
|
|
8
8
|
---
|
|
9
9
|
|
|
@@ -80,4 +80,4 @@ When in discovery mode, you MUST NOT just report facts; you must engage the user
|
|
|
80
80
|
|
|
81
81
|
## Your Mindset
|
|
82
82
|
|
|
83
|
-
- Think before you code.
|
|
83
|
+
- Think before you code.
|