bmad-index-docs

Generate or update index.md files with grouped, alphabetized document links.

Updated May 3, 2026

Search Tags:#documentation #markdown #file organization #directory scanning #index generation #docs navigation

Ready to run

npx skills add https://github.com/tabesink/deepdoc-agent --skill bmad-index-docs-tabesink

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/tabesink/deepdoc-agent/tree/main/.cursor/skills/bmad-index-docs
Command: npx skills add https://github.com/tabesink/deepdoc-agent --skill bmad-index-docs-tabesink

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill solves the problem of keeping a folder of documentation discoverable by automatically creating or updating an index.md that summarizes and links every doc file in the target directory.

Core Features & Use Cases

Directory scanning: Enumerates visible files and subfolders in the chosen target location.
Content-aware descriptions: Reads each file to produce concise 3–10 word descriptions grounded in the file’s actual purpose.
Structured index generation: Writes/updates index.md using grouped, alphabetized listings with correct relative links.

Use case: You add new markdown notes to a docs folder and need an up-to-date landing page that helps users find the right document quickly.

Quick Start

Use the bmad-index-docs Skill to generate an index.md for a target documentation folder by indexing its readable files with brief, accurate summaries.

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?▼

To automatically generate a markdown index for a documentation folder, this skill scans the target directory, reads file contents to produce 3–10 word descriptions, and writes an index.md with grouped, alphabetized relative links.

How does content-aware docs index generation work?▼

Content-aware docs index generation works by scanning visible files and subfolders in a directory, reading each file's actual purpose, and creating concise 3–10 word summaries grounded in those contents for the index.md file.

Can I update an existing index.md after adding new markdown files?▼

Yes, you can update an existing index.md after adding new markdown files by running the skill to refresh the directory index, which re-scans the folder and rewrites the landing page with current grouped, alphabetized links.

What is the best way to organize docs navigation for subdirectories?▼

The best way to organize docs navigation for subdirectories is to use automated index generation, which groups folder entries including subdirectories, alphabetizes them, and writes correct relative ./ links for easy navigation.

Does directory scanning for index generation skip hidden files?▼

Yes, directory scanning for index generation skips hidden files by default to ensure the index.md only references visible documents and relevant subfolders within the target documentation folder.

What happens if the target folder is not writable when generating an index?▼

If the target folder is not writable when generating an index, the process halts immediately to prevent errors, ensuring the index.md file can only be created or updated in directories with proper write permissions.