Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/core/module-help.csv
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
6 changes: 6 additions & 0 deletions src/core/tasks/bmad-index-docs/SKILL.md
Original file line number Diff line number Diff line change
@@ -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'
Comment thread
coderabbitai[bot] marked this conversation as resolved.
---

Follow the instructions in [workflow.md](workflow.md).
Comment thread
coderabbitai[bot] marked this conversation as resolved.
1 change: 1 addition & 0 deletions src/core/tasks/bmad-index-docs/bmad-skill-manifest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
type: skill
61 changes: 61 additions & 0 deletions src/core/tasks/bmad-index-docs/workflow.md
Comment thread
alexeyv marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -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
Comment thread
coderabbitai[bot] marked this conversation as resolved.
Comment thread
alexeyv marked this conversation as resolved.

### Step 2: Group Content

- Organize files by type, purpose, or subdirectory
Comment thread
alexeyv marked this conversation as resolved.

### 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
Comment thread
alexeyv marked this conversation as resolved.
Comment thread
alexeyv marked this conversation as resolved.

### Step 4: Create/Update Index

- Write or update index.md with organized file listings
Comment thread
coderabbitai[bot] marked this conversation as resolved.


## 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
Comment thread
alexeyv marked this conversation as resolved.


## 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
Comment thread
alexeyv marked this conversation as resolved.
- Skip hidden files (starting with .) unless specified
Comment thread
coderabbitai[bot] marked this conversation as resolved.
5 changes: 0 additions & 5 deletions src/core/tasks/bmad-skill-manifest.yaml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
65 changes: 0 additions & 65 deletions src/core/tasks/index-docs.xml

This file was deleted.

Loading