bmad-index-docs

Generate or update an index.md with relative links and file descriptions.

Updated Nov 6, 2025
One-click install
npx skills add https://github.com/skyoxu/godotgame --skill bmad-index-docs-skyoxu
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/skyoxu/godotgame/tree/main/.agents/skills/bmad-index-docs
Command: npx skills add https://github.com/skyoxu/godotgame --skill bmad-index-docs-skyoxu

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates or updates an index.md that references all documents within a target folder, making it easy to locate and browse documentation without manual sifting.

Core Features & Use Cases

  • Scans a target directory and its subfolders to enumerate all docs.
  • Creates concise, 3-10 word descriptions for each file to aid quick understanding.
  • Use Case: prepare a single reference page for a project with many documents, or keep an up-to-date index during audits.

Quick Start

Provide the target folder path and run the skill to generate or update index.md listing all 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 auto-index folder docs for quick reference?

To auto-index folder docs, the skill scans a target directory and writes a standardized index.md containing relative links and concise descriptions for all documents found. It sorts files recursively across subfolders to create a single reference page.

What's the best way to generate an index.md for a large project folder?

Generating an index.md for a large project folder is done by scanning the directory contents, sorting the files, and writing relative links with 3-10 word descriptions per file. This provides a centralized navigation page without manual sifting.

Can I use folder indexing for team onboarding and documentation audits?

Yes, folder indexing supports team onboarding and documentation audits by providing an up-to-date index.md. It enumerates all docs across nested directories, making it easy to locate and browse files during reviews or knowledge transfers.

Does the generated index.md include file descriptions or just links?

The generated index.md includes both relative links and concise per-file descriptions. It creates 3-10 word summaries for each document to aid quick understanding of the folder contents at a glance.

How to update an existing index.md when new documents are added?

To update an existing index.md, run the skill on the target folder to re-scan contents and refresh the file list. It overwrites the previous index with current relative links and descriptions for new and existing documents.

bmad-index-docs: what is it and when do I need it?

bmad-index-docs is a documentation automation skill needed when organizing large project folders, onboarding teams, or auditing nested directories. It solves the problem of manually sifting through files by generating a standardized reference index.