bmad-index-docs

Name: bmad-index-docs
Availability: InStock
Author: GenEd

Generate or update index.md files with grouped relative links and file summaries.

Updated Mar 30, 2026

Search Tags:#documentation #markdown #file organization #content summarization #directory indexing

Ready to run

npx skills add https://github.com/GenEducation/GenedUIProject --skill bmad-index-docs-geneducation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/GenEducation/GenedUIProject/tree/main/.gemini/skills/bmad-index-docs
Command: npx skills add https://github.com/GenEducation/GenedUIProject --skill bmad-index-docs-geneducation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill removes the manual effort of building a navigable index for a documentation folder by creating or updating an index.md that points to every relevant file.

Core Features & Use Cases

Directory Scanning: Collects the files and subdirectories in a target folder before organizing them.
Content-Aware Descriptions: Reads each file to produce short, accurate summaries based on actual content.
Structured Index Generation: Builds a clean index.md grouped by files and subdirectories with relative links.
Use Case: Ideal when a knowledge base, project docs folder, or shared reference directory needs a refreshed entry page that stays easy to browse.

Quick Start

Ask the skill to create or update an index.md for the target folder and organize every documented file with concise descriptions.

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.md file for a documentation folder?▼

To generate an index.md for a documentation folder, this skill scans your directory contents, reads each file to produce accurate summaries, and builds a structured index grouped by type or subdirectory with relative links in alphabetical order.

Can I automatically create content-aware summaries for markdown files in a directory?▼

Yes, you can create content-aware summaries for markdown files by having the skill read each file's actual content and generate short, accurate descriptions for every entry listed in the final directory index.

What is the best way to organize mixed file trees into a navigable documentation index?▼

The best way to organize mixed file trees into a navigable documentation index is scanning the target folder, grouping entries by type or subdirectory, and outputting relative links in alphabetical order.

Does this directory indexing approach work for shared reference spaces with many subdirectories?▼

Yes, this directory indexing approach works for shared reference spaces by scanning all subdirectories, grouping files logically, and creating a clean index.md that provides organized navigation for the entire folder.

How do I update an existing index.md to include newly added documents?▼

To update an existing index.md with newly added documents, the skill re-scans the target directory, reads the new files for summaries, and refreshes the entry page while maintaining alphabetical order and relative links.