bmad-index-docs

Generate or update an index.md with descriptions and relative links for documents in a folder.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates or updates an index.md that references all docs within a target folder, helping users quickly discover documentation.

Core Features & Use Cases

  • Generate a new index.md that lists all documents in a folder with short descriptions.
  • Update an existing index.md to reflect added or removed files.
  • Use Case: You added new manuals to docs/, run the skill to refresh the index for easy navigation.

Quick Start

Provide the path to the 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 generate an index for a folder of mixed documentation?

To generate a documentation index, you provide the target folder path. The skill reads the directory contents, analyzes files to produce concise descriptions, and writes an organized index.md with relative links for quick navigation.

Can I automatically organize documents by type in a directory index?

Yes, you can organize documents by type in a directory index. The skill analyzes the files within the target folder, groups items by type, and generates a centralized index.md referencing all documents with short descriptions.

What is the best way to update an existing index.md when files are added?

The best way to update an existing index.md is to run the skill on the target folder. It refreshes the centralized index to reflect added or removed files, ensuring the directory contents and relative links remain accurate for discovery.

Does this tool require any dependencies to scan folders and create a quick reference index?

No dependencies are required to scan folders and create a quick reference index. The skill operates independently to read directory contents, analyze files, and write an organized index.md for navigation.

How does auto-generating a docs index improve folder-wide navigation?

Auto-generating a docs index improves navigation by creating a centralized index.md that references all documents in a folder. It provides concise descriptions and relative links, allowing users to quickly discover and access mixed documentation.

What happens to the index.md if I remove files from the target documentation folder?

When files are removed from the target documentation folder, running the skill updates the existing index.md. It scans the directory contents again and refreshes the centralized index to reflect the changes, maintaining accurate relative links.