bmad-index-docs

Generate an index.md file with content-based descriptions for directory documents.

1|Updated May 31, 2026

Search Tags:#indexing #file organization #wiki maintenance #directory structure #document cataloging

Ready to run

npx skills add https://github.com/sfines/slf-llm-wiki-py --skill bmad-index-docs-sfines

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/sfines/slf-llm-wiki-py/tree/main/.agents/skills/bmad-index-docs
Command: npx skills add https://github.com/sfines/slf-llm-wiki-py --skill bmad-index-docs-sfines

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Quickly generate or update a directory index to easily navigate through documents, especially in a project's wiki/ folder.

Core Features & Use Cases

Generate Index: Automatically creates or updates an index.md that lists all files in a specified directory.
Detailed Descriptions: Describes each file with a concise explanation, based on file content, not just filenames.
Use Case: Useful for keeping a wiki/ folder well-organized, enabling users to find documents quickly by topic or content.

Quick Start

Run the bmad-index-docs skill on a folder, like this: 'Run index for the wiki/ folder.'.

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 a directory index for a wiki folder?▼

The skill generates a directory index by analyzing file contents to create an index.md file with meaningful descriptions for each document. It categorizes files based on their actual content rather than just filenames, providing a detailed repository overview.

How are file descriptions generated for document cataloging?▼

File descriptions are generated by reading and analyzing the actual content of each file to provide meaningful categorization. This approach ensures the directory index offers concise, context-aware explanations based on what the documents contain.

Can I update an existing markdown index without losing my manual edits?▼

You can update an existing directory index by running the skill again on the folder. It regenerates the index.md file to reflect any added, removed, or modified documents, ensuring your directory structure remains accurately cataloged.

Does this directory indexing approach work for managing large document repositories?▼

This directory indexing approach is ideal for managing document repositories where organization is critical. It requires access to directory contents to generate plain text descriptions, keeping extensive file collections well-organized and easily searchable by topic.

What is the best way to organize files in a project wiki folder?▼

The best way to organize files is to generate an index.md file that lists all documents with detailed content descriptions. This maintains a well-structured wiki folder, enabling users to quickly find documents by topic or content overview.