Skip to content

Commit 9bc208f

Browse files
alexeyvclaude
andcommitted
refactor(skills): convert index-docs.xml to native skill directory
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 1b3c3c5 commit 9bc208f

6 files changed

Lines changed: 69 additions & 71 deletions

File tree

src/core/module-help.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ module,phase,name,code,sequence,workflow-file,command,required,agent,options,des
22
core,anytime,Brainstorming,BSP,,_bmad/core/workflows/brainstorming/workflow.md,bmad-brainstorming,false,analyst,,"Generate diverse ideas through interactive techniques. Use early in ideation phase or when stuck generating ideas.",{output_folder}/brainstorming/brainstorming-session-{{date}}.md,,
33
core,anytime,Party Mode,PM,,_bmad/core/workflows/party-mode/workflow.md,bmad-party-mode,false,party-mode facilitator,,"Orchestrate multi-agent discussions. Use when you need multiple agent perspectives or want agents to collaborate.",,
44
core,anytime,bmad-help,BH,,_bmad/core/tasks/help.md,bmad-help,false,,,"Get unstuck by showing what workflow steps come next or answering BMad Method questions.",,
5-
core,anytime,Index Docs,ID,,_bmad/core/tasks/index-docs.xml,bmad-index-docs,false,,,"Create lightweight index for quick LLM scanning. Use when LLM needs to understand available docs without loading everything.",,
5+
core,anytime,Index Docs,ID,,skill:bmad-index-docs,bmad-index-docs,false,,,"Create lightweight index for quick LLM scanning. Use when LLM needs to understand available docs without loading everything.",,
66
core,anytime,Shard Document,SD,,_bmad/core/tasks/shard-doc.xml,bmad-shard-doc,false,,,"Split large documents into smaller files by sections. Use when doc becomes too large (>500 lines) to manage effectively.",,
77
core,anytime,Editorial Review - Prose,EP,,_bmad/core/tasks/editorial-review-prose.xml,bmad-editorial-review-prose,false,,,"Review prose for clarity, tone, and communication issues. Use after drafting to polish written content.",report located with target document,"three-column markdown table with suggested fixes",
88
core,anytime,Editorial Review - Structure,ES,,_bmad/core/tasks/editorial-review-structure.xml,bmad-editorial-review-structure,false,,,"Propose cuts, reorganization, and simplification while preserving comprehension. Use when doc produced from multiple subprocesses or needs structural improvement.",report located with target document,
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
name: bmad-index-docs
3+
description: 'Generates or updates an index.md to reference all docs in the folder. Use if user requests to create or update an index of all files in a specific folder'
4+
---
5+
6+
Follow the instructions in [workflow.md](workflow.md).
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
type: skill
Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Index Docs
2+
3+
**Goal:** Generate or update an index.md to reference all docs in a target folder.
4+
5+
6+
## EXECUTION
7+
8+
### Step 1: Scan Directory
9+
10+
- List all files and subdirectories in the target location
11+
12+
### Step 2: Group Content
13+
14+
- Organize files by type, purpose, or subdirectory
15+
16+
### Step 3: Generate Descriptions
17+
18+
- Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename
19+
20+
### Step 4: Create/Update Index
21+
22+
- Write or update index.md with organized file listings
23+
24+
25+
## OUTPUT FORMAT
26+
27+
```markdown
28+
# Directory Index
29+
30+
## Files
31+
32+
- **[filename.ext](./filename.ext)** - Brief description
33+
- **[another-file.ext](./another-file.ext)** - Brief description
34+
35+
## Subdirectories
36+
37+
### subfolder/
38+
39+
- **[file1.ext](./subfolder/file1.ext)** - Brief description
40+
- **[file2.ext](./subfolder/file2.ext)** - Brief description
41+
42+
### another-folder/
43+
44+
- **[file3.ext](./another-folder/file3.ext)** - Brief description
45+
```
46+
47+
48+
## HALT CONDITIONS
49+
50+
- HALT if target directory does not exist or is inaccessible
51+
- HALT if user does not have write permissions to create index.md
52+
53+
54+
## VALIDATION
55+
56+
- Use relative paths starting with ./
57+
- Group similar files together
58+
- Read file contents to generate accurate descriptions - don't guess from filenames
59+
- Keep descriptions concise but informative (3-10 words)
60+
- Sort alphabetically within groups
61+
- Skip hidden files (starting with .) unless specified

src/core/tasks/bmad-skill-manifest.yaml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@ help.md:
1313
type: task
1414
description: "Analyzes what is done and the users query and offers advice on what to do next"
1515

16-
index-docs.xml:
17-
canonicalId: bmad-index-docs
18-
type: task
19-
description: "Generates or updates an index.md to reference all docs in the folder"
20-
2116
review-edge-case-hunter.xml:
2217
canonicalId: bmad-review-edge-case-hunter
2318
type: task

src/core/tasks/index-docs.xml

Lines changed: 0 additions & 65 deletions
This file was deleted.

0 commit comments

Comments
 (0)