bmad-index-docs

Generate a structured index.md listing files grouped by type and subfolder.

Updated Apr 2, 2026
One-click install
npx skills add https://github.com/amitmishra-byldd/Bmad-Note-Maker --skill bmad-index-docs-amitmishra-byldd
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/amitmishra-byldd/Bmad-Note-Maker/tree/main/_bmad/core/bmad-index-docs
Command: npx skills add https://github.com/amitmishra-byldd/Bmad-Note-Maker --skill bmad-index-docs-amitmishra-byldd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Organizes and speeds up access to project documents by generating a single index.md that references every file in a target folder.

Core Features & Use Cases

  • Scan the target folder to enumerate all files and subdirectories.
  • Group content by type and subfolder to improve readability.
  • Generate concise, content-based descriptions for each item rather than relying on filenames.
  • Create or update index.md with the structured listing for documentation sharing, onboarding, or archival.
  • Use Case: Quick onboarding or project handoffs where a single index of docs accelerates understanding.

Quick Start

Create or refresh an index.md for the target folder to summarize all contained docs.

Frequently Asked Questions about bmad-index-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate a markdown index for all files in a folder?

To automatically generate a markdown index, you can scan the target folder to enumerate all files and subdirectories, grouping them by type and subfolder. The process creates an index.md with structured listings and relative paths.

What is the best way to organize project documentation for quick onboarding?

Organizing project documentation for onboarding is best achieved by creating a single index.md that references every file in a target folder. This structured listing groups content by type and generates concise, content-based descriptions for each item.

How do I create content-based descriptions for indexed documents instead of just filenames?

Creating content-based descriptions for indexed documents involves scanning file contents to generate concise summaries rather than relying on filenames. The generated index.md will group these descriptions alphabetically within their respective file type or subfolder groups.

Can I update an existing index.md without manually rewriting the entire file?

Yes, you can update an existing index.md by writing or refreshing the file with a new structured listing. The process maintains alphabetic order within groups and uses relative paths to reference every document accurately.

Does folder indexing work with nested subdirectories and mixed file types?

Folder indexing works with nested subdirectories and mixed file types by grouping content by subfolder and type to improve readability. It enumerates all files and subdirectories within the target folder to ensure comprehensive coverage.