bmad-index-docs

Generate index.md files referencing all docs in a folder.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generating and maintaining an index of documentation across a folder helps teams quickly locate relevant files and understand project structure without manual curation.

Core Features & Use Cases

  • Automatically scans target folders and subfolders to collect file metadata.
  • Generates a clean, navigable index.md with descriptive entries for each file.
  • Use Case: When onboarding new contributors, generate an up-to-date index to accelerate navigation.

Quick Start

Create or update the index.md for the current directory to reflect 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 automatically generate an index for documentation files in a folder?

Automatically generate an index by scanning target folders and subfolders to collect file metadata, then producing a navigable index.md with short descriptions for each file.

What is the best way to create a navigable index.md for project documentation?

The best way to create a navigable index.md is to automatically scan directories and subfolders, gathering file metadata and generating alphabetical groupings with 3 to 10 word descriptions.

How does auto-indexing handle subfolders and relative paths?

Auto-indexing handles subfolders by operating recursively on the current directory and any nested folders, satisfying relative path rules to ensure all references remain navigable and accurate.

Can I use an automatic documentation index generator for onboarding new contributors?

Yes, you can use an automatic documentation index generator for onboarding new contributors to accelerate navigation and help them understand the project structure without manual curation.

What happens if the documentation indexer encounters inaccessible folders?

If the documentation indexer encounters inaccessible folders during the scanning process, it halts operation to prevent incomplete or broken references in the generated index.md file.