doc-indexer

Extract YAML frontmatter from markdown files in the docs directory.

Updated Sep 11, 2024
One-click install
npx skills add https://github.com/Reading-Advantage-Thailand/www-reading-advantage --skill doc-indexer-reading-advantage-thailand
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-indexer
Source: https://github.com/Reading-Advantage-Thailand/www-reading-advantage/tree/main/.claude-old/skills/doc-indexer
Command: npx skills add https://github.com/Reading-Advantage-Thailand/www-reading-advantage --skill doc-indexer-reading-advantage-thailand

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill provides quick access to project documentation by scanning metadata, avoiding the need to load entire files and consume excessive tokens.

Core Features & Use Cases

  • Metadata Scanning: Extracts YAML frontmatter from all Markdown files in the docs/ directory.
  • Efficient Discovery: Helps locate relevant specs, proposals, and other documents without reading them fully.
  • Use Case: Before starting a new task, use this Skill to get an overview of all approved specifications in the docs/specs/ directory, allowing you to quickly identify the most relevant ones.

Quick Start

Run the bash script 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 scan markdown documentation to find specific specs without loading full files?

You can scan markdown documentation by extracting YAML frontmatter to map available files. This parses file metadata without loading full content, minimizing token usage while locating relevant specs.

What is the best way to retrieve context from project documentation directories?

The best way to retrieve context is scanning YAML frontmatter in the docs directory. This provides a structured map of available project documentation for just-in-time discovery of proposals and plans.

How do I get an overview of available project documentation before starting a task?

Get an overview of project documentation by running a bash script to scan markdown files. This extracts metadata from files in the docs directory, helping you identify relevant approved specifications quickly.

Can I discover proposals and plans in markdown files without consuming excessive tokens?

Yes, you can discover proposals and plans without excessive tokens by scanning YAML frontmatter. This approach parses only file metadata instead of loading entire markdown files, facilitating efficient context retrieval.

Does this documentation scanning approach work with standard markdown files in a docs directory?

Yes, this approach works with standard markdown files containing YAML frontmatter in the docs directory. It scans all markdown files to extract structured metadata, providing a map of available documentation.

Why should I parse YAML frontmatter instead of loading entire markdown files for documentation discovery?

Parse YAML frontmatter instead of loading entire files to minimize token usage during documentation discovery. Scanning metadata provides a structured map of available documents, avoiding the need to read full content.