skills.rest
Dydyy-y
Dydyy-yCOMMUNITY
Explore all skills by this author →
GitHub

bmad-index-docs

Scan a directory and generate an index.md file listing documents with descriptions.

Updated Mar 10, 2026
Search Tags:#indexing#file organization#document management#directory scanning#index generation
One-click install
npx skills add https://github.com/Dydyy-y/react-native --skill bmad-index-docs-dydyy-y
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/Dydyy-y/react-native/tree/main/projet/.github/skills/bmad-index-docs
Command: npx skills add https://github.com/Dydyy-y/react-native --skill bmad-index-docs-dydyy-y

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Manages the organization and indexing of documents within a folder, providing an efficient way to reference and navigate through a collection of files.

Core Features & Use Cases

  • Directory Scanning: Automatically scans a folder for all files and subdirectories.
  • Content Grouping: Categorizes files based on type, purpose, or subdirectory.
  • Description Generation: Generates concise descriptions for each file to help users understand their content quickly.
  • Index Creation: Generates or updates an index.md file that lists all files and their descriptions.
  • Use Case: Ideal for project folders or documentation repositories where quick access to documents is crucial.

Quick Start

Use the bmad-index-docs skill to generate an index for the 'project/docs' 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 an index of all documents in a project folder?▼

To generate an index of all documents in a project folder, this Skill scans the specified directory and automatically creates an index.md file listing all files with concise descriptions for quick navigation.

What is the best way to organize and index files in a documentation repository?▼

Organizing and indexing files in a documentation repository is achieved by scanning directories, categorizing files based on type or subdirectory, and generating a centralized index.md file for efficient file referencing.

Can I automatically scan a directory and create a markdown index without manual input?▼

Yes, you can automatically scan a directory and create a markdown index without manual input by running this Skill, which processes files and generates descriptions entirely autonomously.

How does directory scanning work for updating an existing index.md file?▼

Directory scanning for updating an existing index.md file works by recursively reading the folder structure, detecting all documents, and regenerating or updating the index with current file references and descriptions.

Does this document indexing approach group files by type or subdirectory?▼

Yes, this document indexing approach groups files by type, purpose, or subdirectory during the directory scanning process to logically categorize files within the generated index.md file.

Related Skills

Explore More Software Engineering Skills→
openakitaopenakita
2.0k

list-directory

List files and subdirectories with metadata from a specified directory path.

Community
Basic
tech-leads-clubtech-leads-club
5.0k

render-deploy

Analyze a codebase and generate render.yaml blueprints for Render deployments.

Official
Advanced
JordanGunnJordanGunn
6

md-split

Split Markdown files into numbered documents at H2 headings with slug-based filenames and an index.

Community
Intermediate
co-cddoco-cddo
4

bmad-index-docs

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

Official
Intermediate