bmad-index-docs

Generate or update index.md by scanning documentation files in a target directory.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of quickly creating and maintaining an accurate index.md that maps a folder’s contents without manually listing and describing every file.

Core Features & Use Cases

  • Directory scanning: Enumerates files and subdirectories in a specified target folder.
  • Content-based summaries: Reads each file to produce concise (3-10 word) descriptions based on actual purpose.
  • Structured index generation: Writes or updates index.md with organized sections and alphabetized entries, including subfolder listings.

Quick Start

Ask the AI to run bmad-index-docs to generate or update index.md for the folder you specify.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I auto-generate an index.md for a documentation-heavy folder?

To auto-generate an index.md, this Skill scans your target directory, reads each documentation file, and creates an organized listing with concise 3-10 word content summaries. It categorizes files and subfolders alphabetically to provide an accurate navigational map.

What is the best way to create a folder document index without manual listing?

The best way to create a folder document index is using an automated directory scanner that reads file contents and writes structured sections to index.md. This approach extracts actual file purposes to generate accurate descriptions without manual entry.

Does the index.md generator scan subdirectories and hidden files?

The index.md generator scans subdirectories and includes them in the structured listing. It skips hidden files by default unless explicitly instructed, and sorts all entries alphabetically within their respective groups using relative paths.

Why does markdown organization fail when scanning missing directories?

Markdown organization fails because the Skill halts execution upon encountering missing or inaccessible target directories. It also stops if there are insufficient write permissions, ensuring index.md generation only proceeds with valid access.

Can I update an existing index.md with new repository navigation entries?

Yes, you can update an existing index.md. The Skill generates or updates the file by scanning the specified folder, reading current documentation files, and applying markdown organization to reflect the latest directory contents and summaries.