bmad-index-docs

Generate sorted index.md files with content-based descriptions for document folders.

1|Updated Mar 31, 2026
One-click install
npx skills add https://github.com/mol4/BMAD-Board --skill bmad-index-docs-mol4
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/mol4/BMAD-Board/tree/main/BMAD%20board/.agents/skills/bmad-index-docs
Command: npx skills add https://github.com/mol4/BMAD-Board --skill bmad-index-docs-mol4

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the manual work of building and maintaining readable folder indexes for documentation-heavy directories, making it easier to discover files and understand what belongs where.

Core Features & Use Cases

  • Directory Scanning: Lists files and subfolders in a target location.
  • Content-Aware Descriptions: Reads documents to create concise, accurate summaries based on actual content.
  • Index Maintenance: Generates or updates an organized index.md with relative links and grouped listings.
  • Use Case: A team with a large knowledge base can quickly publish a clean index for every docs folder so contributors can find the right file without guessing.

Quick Start

Ask the skill to scan the target folder and generate or update an index.md with concise descriptions for every visible file and subdirectory.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I generate a markdown index for a documentation folder?

To generate a markdown index for a documentation folder, scan the directory contents to group files by type or subdirectory, read content for brief descriptions, and output a relative-link index.md. This automates navigation and documentation discovery.

What is the best way to organize markdown files for repository navigation?

Organizing markdown files for repository navigation is best handled by scanning visible contents and producing a grouped index.md with relative links. This provides a clean folder overview and accurate file summaries without manual work.

How do I automatically create descriptions for files in a directory index?

To automatically create descriptions for files in a directory index, read the actual content of each document to write concise, accurate summaries. This content-aware approach ensures the generated index.md reflects true file contents.

Can I update an existing index.md with relative links for new markdown files?

You can update an existing index.md with relative links by scanning the target workspace directory for new markdown files and regenerating the sorted listings. This maintains accurate documentation discovery without manual edits.

Does directory scanning for documentation indexes work without external dependencies?

Directory scanning for documentation indexes works without external dependencies, directly reading visible contents and markdown files to generate grouped listings. This ensures quick folder overviews in any repository environment.