doc-indexer

Scan Markdown files in docs/ and extract YAML frontmatter metadata.

11|3|Updated Oct 21, 2025
One-click install
npx skills add https://github.com/bodangren/git-workflow --skill doc-indexer
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-indexer
Source: https://github.com/bodangren/git-workflow/tree/main/.claude/skills/doc-indexer
Command: npx skills add https://github.com/bodangren/git-workflow --skill doc-indexer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill helps you quickly understand the available project documentation without needing to load the full content of every file, saving valuable context window space.

Core Features & Use Cases

  • Metadata Scanning: Extracts YAML frontmatter from all Markdown files in the docs/ directory.
  • Context Mapping: Provides a structured overview of available documentation (specs, plans, retrospectives).
  • Use Case: Before starting a new feature, run this skill to see a list of all approved specifications and their titles, allowing you to quickly identify the most relevant document to read next.

Quick Start

Use the doc-indexer skill to scan all markdown files in the docs directory.

Frequently Asked Questions about doc-indexer

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

FAQPage Schema
How do I extract YAML frontmatter metadata from markdown files to save context window space?

To extract YAML frontmatter metadata and save context window space, scan all markdown files within the 'docs/' directory. This process identifies compliant and non-compliant files, outputting a structured map for efficient documentation discovery without loading full file contents.

What is the best way to map available project documentation without reading every file?

The best way to map available project documentation without reading every file is to scan markdown files for YAML frontmatter. This approach provides a structured overview of available specs, plans, and retrospectives, saving valuable context window space.

Does doc-indexer work with markdown files outside the docs directory?

Doc-indexer specifically targets markdown files within the 'docs/' directory. It scans this location to extract YAML frontmatter metadata and identify non-compliant files, providing a structured map for efficient documentation discovery.

How do I identify markdown files with missing or non-compliant YAML frontmatter?

To identify markdown files with non-compliant YAML frontmatter, scan the 'docs/' directory to extract metadata. The process identifies both compliant and non-compliant files, providing a structured map that highlights missing or incomplete documentation metadata.

Can I get JSON output from scanning documentation metadata for programmatic use?

You can output extracted documentation metadata in JSON format for programmatic use. This skill supports both human-readable and JSON output formats, allowing automated systems to easily consume the structured map of available documentation.