bmad-index-docs

Generate or update an index.md referencing all docs in a target folder.

Updated Mar 18, 2026
One-click install
npx skills add https://github.com/robotics-playground/skills --skill bmad-index-docs-robotics-playground
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/robotics-playground/skills/tree/main/_bmad/core/skills/bmad-index-docs
Command: npx skills add https://github.com/robotics-playground/skills --skill bmad-index-docs-robotics-playground

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automatically generates or updates an index.md that references all docs in a target folder, simplifying documentation navigation.

Core Features & Use Cases

  • Scan a target directory to discover all files and subfolders.
  • Group content by type and subdirectory, generating concise, descriptive entries.
  • Write or update a structured Markdown index that links to each file.

Quick Start

Run the skill on a target folder to generate or update its index.md.

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 directory of documentation files?

To generate a markdown index for a directory, the skill scans your target folder, groups similar files, reads content for concise descriptions, and writes a structured index.md with relative paths sorted alphabetically.

What is the best way to create an index.md that links to all files in a folder?

The best way to create an index.md is to automate directory scanning and file content analysis, which groups files by type and subdirectory to produce concise, descriptive links to each document automatically.

How does automated directory indexing handle file grouping and content discovery?

Automated directory indexing handles content discovery by scanning the target folder, grouping content by type and subdirectory, and reading file contents to generate concise, descriptive Markdown entries.

What happens if the target directory for documentation indexing is missing or write-protected?

If the target directory for documentation indexing is missing or write-protected, the automated process halts immediately to prevent errors and ensure the index.md is only updated in accessible folders.

Can I update an existing markdown documentation index without regenerating it from scratch?

Yes, you can update an existing markdown documentation index automatically. The skill scans the directory and writes or updates the structured index.md, ensuring all current files are referenced without starting over.

Does the generated markdown index use relative paths for file descriptions?

Yes, the generated markdown index uses relative paths for all file descriptions. It sorts entries alphabetically and links to each file using paths relative to the target directory.