skills.rest
JingyiWng
JingyiWngCOMMUNITY
Explore all skills by this author →
GitHub

bmad-index-docs

Generates and updates index.md files by scanning directories and summarizing document contents.

Updated Mar 25, 2026
Search Tags:#automation#documentation#markdown#description#generate#index#folder
One-click install
npx skills add https://github.com/JingyiWng/databricks_ai_dev_kit_price_watcher --skill bmad-index-docs-jingyiwng
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/JingyiWng/databricks_ai_dev_kit_price_watcher/tree/main/_bmad/core/skills/bmad-index-docs
Command: npx skills add https://github.com/JingyiWng/databricks_ai_dev_kit_price_watcher --skill bmad-index-docs-jingyiwng

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manually building and maintaining an index of documentation files is time‑consuming and error‑prone. This Skill automates the creation and updating of a comprehensive index.md for any folder.

Core Features & Use Cases

  • Directory Scanning: Lists all files and subfolders in the target location.
  • Content‑Based Descriptions: Reads each file to generate concise, accurate summaries.
  • Structured Index Generation: Writes or updates index.md with organized listings, grouped by type or subdirectory.
  • Use Case: Quickly produce an up‑to‑date navigation page for a project's docs/ folder, ensuring collaborators can find relevant files instantly.

Quick Start

Generate an index for the './docs' directory.

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 a markdown index for my documentation folder?▼

Generating an index.md involves scanning a target directory, reading each documentation file to produce concise summaries, and writing an organized listing grouped by type or subfolder.

How does automated documentation indexing handle folder scanning and descriptions?▼

Automated documentation indexing scans the target directory to list files, reads each file to generate a concise content description, and groups these entries by type or subfolder in the output.

What is the best way to update an existing index.md without manual entry?▼

Updating an index.md without manual entry requires an automated tool that re-scans the target directory, validates file existence, and modifies the markdown file to reflect current documentation.

Do I need specific folder permissions to create an automated index of markdown files?▼

Creating an automated index of markdown files requires read access to the target folder to scan files and write permissions to create or modify the index.md file.

Can I group documentation files by subfolder when generating an index?▼

When generating an index, documentation files can be grouped by type or subdirectory, producing a structured markdown index that organizes listings logically for collaborators.

Why does my documentation index need file existence validation before proceeding?▼

Documentation index generation requires file existence validation to ensure the tool only processes and references current files, preventing broken links and errors when writing the structured markdown index.

Related Skills

Explore More Content & Communication Skills→
MarkusonMarkuson

bmad-index-docs

Generate or update an index.md file with categorized file and subdirectory listings.

Community
Basic
LusciiLuscii

mermaid-diagrams

Embed Mermaid diagrams in Markdown documents for visualizations.

Official
Basic
romamoromamo
5

validate-links

Validate cross-links across markdown files, schemas, and index coverage.

Community
Intermediate
lbliiilbliii
41

bengal-site-scaffold

Scaffold a Bengal static site with configuration, content structure, and theme setup.

Community
Basic