init-docs

Generate aggregator README.md files for documentation directories lacking one.

11|Updated Mar 19, 2019
One-click install
npx skills add https://github.com/lukoshkin/evangelist --skill init-docs-lukoshkin
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: init-docs
Source: https://github.com/lukoshkin/evangelist/tree/main/conf/ai/claude/skills/init-docs
Command: npx skills add https://github.com/lukoshkin/evangelist --skill init-docs-lukoshkin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of aggregator README.md files for documentation directories that lack one, ensuring consistent structure and enabling smooth integration with /upd-docs.

Core Features & Use Cases

  • Generates an aggregator README.md for a target docs subdirectory lacking one.
  • Scans docs/* directories to detect missing aggregators and proposes a standard layout with a Topic Index-like section.
  • Produces a review-ready README.md that can be adapted by users before committing.

Quick Start

Run the init-docs process on the target docs directory to create an aggregator README.md.

Frequently Asked Questions about init-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I generate a README for my docs subdirectories?▼

To generate a README for docs subdirectories, run the init-docs process on the target folder. It scans docs/* structures, derives topic entries from headings and files, and outputs a ready-to-review README.md aggregator file.

What is an aggregator README and when do I need one?▼

An aggregator README provides a consistent overview and Key Files-like indexing for a documentation directory. You need one when your docs/* subdirectories lack a central index, making it difficult to navigate scattered topic files.

How do I scan documentation folders to find missing index files?▼

You can scan documentation folders to find missing index files by running an automated docs aggregation process. It detects subdirectories lacking a README.md and proposes a standard layout with a Topic Index-like section.

Can I review and edit the generated documentation README before committing?▼

Yes, you can review and edit the generated documentation README before committing. The process produces a review-ready README.md file that users can adapt and modify to fit their specific documentation structure before finalizing.

Does this docs aggregation tool work with any markdown directory structure?▼

This docs aggregation tool is specifically designed for documentation structures under docs/*. It scans these subdirectories to derive topic entries from existing headings and files, ensuring the generated README.md matches your documentation layout.