docs-index

Regenerate docs/INDEX.md from Markdown frontmatter and summaries.

41|7|Updated Jan 30, 2026

Search Tags:#automation #documentation #markdown #verification #navigation #index #docs-index

Ready to run

npx skills add https://github.com/DGouron/review-flow --skill docs-index-dgouron

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-index
Source: https://github.com/DGouron/review-flow/tree/main/.claude/skills/docs-index
Command: npx skills add https://github.com/DGouron/review-flow --skill docs-index-dgouron

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill automates generation and updating of a centralized documentation index (docs/INDEX.md) to reflect navigation structure and cross-references across the repository's docs.

Core Features & Use Cases

Auto-generate and regenerate docs/INDEX.md from the docs tree.
Parse docs/**/*.md frontmatter (title, scope, last-updated) and extract the first paragraph as a summary.
Always regenerate from scratch and verify that all links are valid, organizing content by topic and ensuring the index stays in sync with documentation changes.

Quick Start

Regenerate the docs/INDEX.md from the current docs tree after adding, removing, or renaming documents.

Frequently Asked Questions about docs-index

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

FAQPage Schema

How do I automatically generate a documentation index for Markdown files?▼

To automatically generate a documentation index, this Skill scans Markdown files under docs/, parses frontmatter for titles and scopes, extracts the first paragraph as a summary, and regenerates the INDEX.md file from scratch.

What's the best way to keep a docs navigation index in sync after renaming files?▼

The best way to keep a docs navigation index in sync is to regenerate it from the current docs tree, which automatically reflects any added, removed, or renamed Markdown documents while verifying all links.

Does the docs index regeneration verify internal Markdown links?▼

Yes, the docs index regeneration verifies internal Markdown links by rebuilding the INDEX.md file from scratch and checking that all cross-references across the repository's documentation remain valid.

How do I organize Markdown documentation by topic in a central index?▼

You organize Markdown documentation by topic by scanning the frontmatter scope of your docs/**/*.md files and aggregating them into a centralized INDEX.md that categorizes content and includes summaries.

Can I use this to update an existing INDEX.md without manual editing?▼

Yes, you can update an existing INDEX.md without manual editing because the Skill regenerates the file completely from scratch based on the current state of your Markdown documentation tree.