bmad-index-docs

Generates or updates index.md with organized links and descriptions for visible files in a target directory.

Updated May 23, 2026
One-click install
npx skills add https://github.com/diegosanchespereira1/lavarapido --skill bmad-index-docs-diegosanchespereira1
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/diegosanchespereira1/lavarapido/tree/main/lava-rapido/.agents/skills/bmad-index-docs
Command: npx skills add https://github.com/diegosanchespereira1/lavarapido --skill bmad-index-docs-diegosanchespereira1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the manual work of cataloging documents in a folder by creating a clear, organized index that points to every relevant file.

Core Features & Use Cases

  • Directory Scanning: Inspects the target folder and its visible contents.
  • Accurate File Summaries: Reads each file to write short descriptions based on actual content.
  • Structured Output: Groups files and subdirectories into a clean index.md with relative links.
  • Use Case: A documentation folder with many scattered notes, guides, and subfolders can be turned into a readable entry point for teammates or future maintenance.

Quick Start

Ask the skill to generate or update an index.md for the target folder using concise, content-based descriptions for every visible file.

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 a documentation folder?

A folder index catalogs documents by scanning the target directory, reading file contents to write concise descriptions, and generating an index.md with organized relative links. It groups files and subdirectories into a structured, readable entry point.

Can I create a file inventory that skips hidden items and preserves relative paths?

Yes, the Skill creates file inventories that skip hidden items and preserve relative paths. It scans only visible files during the directory scan, generating an index.md that maintains accurate relative links without including hidden files.

What is the best way to catalog scattered notes and guides into a readable entry point?

Cataloging scattered notes is done by scanning the directory and reading each file to write short descriptions based on actual content. This generates an index.md that transforms scattered notes and guides into a structured, readable entry point.

Does the generated index.md include content-based summaries or just file names?

The generated index.md includes content-based summaries, not just file names. The Skill reads each visible file's actual content to write short descriptions, ensuring the directory scan produces accurate file summaries rather than simple filename listings.

Are there limitations when scanning subdirectories with hidden files for a knowledge base index?

A limitation is that the Skill skips hidden items entirely during the directory scan. When generating an index.md for a knowledge base, hidden files are ignored, ensuring only visible contents are cataloged with relative paths and concise descriptions.