diff --git a/src/core/module-help.csv b/src/core/module-help.csv index f83e90206..2e3845767 100644 --- a/src/core/module-help.csv +++ b/src/core/module-help.csv @@ -2,7 +2,7 @@ module,phase,name,code,sequence,workflow-file,command,required,agent,options,des 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,, 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.",, core,anytime,bmad-help,BH,,skill:bmad-help,bmad-help,false,,,"Get unstuck by showing what workflow steps come next or answering BMad Method questions.",, -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.",, +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.",, 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.",, core,anytime,Editorial Review - Prose,EP,,skill:bmad-editorial-review-prose,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", core,anytime,Editorial Review - Structure,ES,,skill:bmad-editorial-review-structure,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, diff --git a/src/core/tasks/bmad-index-docs/SKILL.md b/src/core/tasks/bmad-index-docs/SKILL.md new file mode 100644 index 000000000..30e451a62 --- /dev/null +++ b/src/core/tasks/bmad-index-docs/SKILL.md @@ -0,0 +1,6 @@ +--- +name: bmad-index-docs +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' +--- + +Follow the instructions in [workflow.md](workflow.md). diff --git a/src/core/tasks/bmad-index-docs/bmad-skill-manifest.yaml b/src/core/tasks/bmad-index-docs/bmad-skill-manifest.yaml new file mode 100644 index 000000000..d0f08abdb --- /dev/null +++ b/src/core/tasks/bmad-index-docs/bmad-skill-manifest.yaml @@ -0,0 +1 @@ +type: skill diff --git a/src/core/tasks/bmad-index-docs/workflow.md b/src/core/tasks/bmad-index-docs/workflow.md new file mode 100644 index 000000000..b500cf984 --- /dev/null +++ b/src/core/tasks/bmad-index-docs/workflow.md @@ -0,0 +1,61 @@ +# Index Docs + +**Goal:** Generate or update an index.md to reference all docs in a target folder. + + +## EXECUTION + +### Step 1: Scan Directory + +- List all files and subdirectories in the target location + +### Step 2: Group Content + +- Organize files by type, purpose, or subdirectory + +### Step 3: Generate Descriptions + +- Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the filename + +### Step 4: Create/Update Index + +- Write or update index.md with organized file listings + + +## OUTPUT FORMAT + +```markdown +# Directory Index + +## Files + +- **[filename.ext](./filename.ext)** - Brief description +- **[another-file.ext](./another-file.ext)** - Brief description + +## Subdirectories + +### subfolder/ + +- **[file1.ext](./subfolder/file1.ext)** - Brief description +- **[file2.ext](./subfolder/file2.ext)** - Brief description + +### another-folder/ + +- **[file3.ext](./another-folder/file3.ext)** - Brief description +``` + + +## HALT CONDITIONS + +- HALT if target directory does not exist or is inaccessible +- HALT if user does not have write permissions to create index.md + + +## VALIDATION + +- Use relative paths starting with ./ +- Group similar files together +- Read file contents to generate accurate descriptions - don't guess from filenames +- Keep descriptions concise but informative (3-10 words) +- Sort alphabetically within groups +- Skip hidden files (starting with .) unless specified diff --git a/src/core/tasks/bmad-skill-manifest.yaml b/src/core/tasks/bmad-skill-manifest.yaml index e5fcd157c..cec3da4a5 100644 --- a/src/core/tasks/bmad-skill-manifest.yaml +++ b/src/core/tasks/bmad-skill-manifest.yaml @@ -1,8 +1,3 @@ -index-docs.xml: - canonicalId: bmad-index-docs - type: task - description: "Generates or updates an index.md to reference all docs in the folder" - shard-doc.xml: canonicalId: bmad-shard-doc type: task diff --git a/src/core/tasks/index-docs.xml b/src/core/tasks/index-docs.xml deleted file mode 100644 index 871501e1c..000000000 --- a/src/core/tasks/index-docs.xml +++ /dev/null @@ -1,65 +0,0 @@ - - - MANDATORY: Execute ALL steps in the flow section IN EXACT ORDER - DO NOT skip steps or change the sequence - HALT immediately when halt-conditions are met - Each action xml tag within step xml tag is a REQUIRED action to complete that step - Sections outside flow (validation, output, critical-context) provide essential context - review and apply throughout execution - - - - - List all files and subdirectories in the target location - - - - Organize files by type, purpose, or subdirectory - - - - Read each file to understand its actual purpose and create brief (3-10 word) descriptions based on the content, not just the - filename - - - - Write or update index.md with organized file listings - - - - - - # Directory Index - - ## Files - - - **[filename.ext](./filename.ext)** - Brief description - - **[another-file.ext](./another-file.ext)** - Brief description - - ## Subdirectories - - ### subfolder/ - - - **[file1.ext](./subfolder/file1.ext)** - Brief description - - **[file2.ext](./subfolder/file2.ext)** - Brief description - - ### another-folder/ - - - **[file3.ext](./another-folder/file3.ext)** - Brief description - - - - - HALT if target directory does not exist or is inaccessible - HALT if user does not have write permissions to create index.md - - - - Use relative paths starting with ./ - Group similar files together - Read file contents to generate accurate descriptions - don't guess from filenames - Keep descriptions concise but informative (3-10 words) - Sort alphabetically within groups - Skip hidden files (starting with .) unless specified - - \ No newline at end of file