-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
refactor(skills): convert index-docs.xml to native skill directory #1878
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
alexeyv
merged 1 commit into
bmad-code-org:main
from
alexeyv:refactor/convert-index-docs
Mar 11, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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' | ||
| --- | ||
|
|
||
| Follow the instructions in [workflow.md](workflow.md). | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| type: skill |
|
alexeyv marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
coderabbitai[bot] marked this conversation as resolved.
alexeyv marked this conversation as resolved.
|
||
|
|
||
| ### Step 2: Group Content | ||
|
|
||
| - Organize files by type, purpose, or subdirectory | ||
|
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 | ||
|
alexeyv marked this conversation as resolved.
alexeyv marked this conversation as resolved.
|
||
|
|
||
| ### Step 4: Create/Update Index | ||
|
|
||
| - Write or update index.md with organized file listings | ||
|
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 | ||
|
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 | ||
|
alexeyv marked this conversation as resolved.
|
||
| - Skip hidden files (starting with .) unless specified | ||
|
coderabbitai[bot] marked this conversation as resolved.
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.