bmad-index-docs

Generate or update an index.md file summarizing directory contents.

Updated Jul 11, 2026
One-click install
npx skills add https://github.com/marcmontecalvo/kinward --skill bmad-index-docs-marcmontecalvo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/marcmontecalvo/kinward/tree/main/.agents/skills/bmad-index-docs
Command: npx skills add https://github.com/marcmontecalvo/kinward --skill bmad-index-docs-marcmontecalvo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the problem of documentation sprawl by automatically creating or updating an index.md file that maps out the contents of a directory, ensuring users can easily navigate and understand project documentation.

Core Features & Use Cases

  • Automated Scanning: Recursively lists files and subdirectories within a target path.
  • Contextual Summarization: Analyzes file content to generate meaningful, concise descriptions rather than relying on filenames.
  • Use Case: When a project folder grows too large to manage manually, use this skill to generate a clean, readable index that helps team members find relevant files quickly.

Quick Start

Use the bmad-index-docs skill to generate an index for the current directory.

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 an index file for directory documentation?

To generate an index file for directory documentation, you need a tool that recursively scans folders and creates an index.md file mapping contents. This skill scans the target path and writes a structured overview of files and subdirectories.

What's the best way to organize markdown files in a large project folder?

Organizing markdown files in large folders requires generating a structured index that maps directory contents. This skill scans target directories and creates concise, content-aware summaries for each file to ensure easy navigation.

Does generating a directory index require scanning file content or just filenames?

Generating a directory index with this skill requires scanning file content, not just filenames. It analyzes the actual content of files and subdirectories to generate meaningful, concise descriptions for each entry in the index.md file.

Can I use an automated indexing tool for documentation maintenance?

You can use this automated indexing tool for documentation maintenance by scanning directory contents and creating or updating an index.md file. It facilitates maintenance by providing a structured overview of project files.

Do I need specific permissions to create an index.md file in a target folder?

To create an index.md file in a target folder, you need read access to the target directory and write permissions to create or modify the index file. These permissions allow the tool to scan contents and write the structured overview.

Why does documentation sprawl happen and how can an index help?

Documentation sprawl happens when project folders grow too large to manage manually. An index.md file helps by mapping out directory contents with concise summaries, ensuring team members can easily navigate and understand project documentation.