index-docs

Index documentation and code into searchable artifacts under .claude/index/.

2|2|Updated Oct 28, 2025
One-click install
npx skills add https://github.com/adolfoaranaes12/BMAD-ENHANCED --skill index-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: index-docs
Source: https://github.com/adolfoaranaes12/BMAD-ENHANCED/tree/main/.claude/skills/index-docs
Command: npx skills add https://github.com/adolfoaranaes12/BMAD-ENHANCED --skill index-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires yaml, markdown-toc, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill indexes documentation and code to enable fast context lookup in brownfield projects, generating search.json, quick-ref, and glossary to accelerate onboarding and task planning.

Core Features & Use Cases

  • Scan docs/ and src/ to extract sections, keywords, and code references
  • Build cross-linked indexes for quick search
  • Produce search.json, quick-ref.md, and glossary.md under .claude/index/

Quick Start

Run the skill to generate an index of current docs and code, enabling fast context lookup.

Frequently Asked Questions about index-docs

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

FAQPage Schema
How do I build a searchable index from documentation and code?

A searchable index extracts sections and keywords from docs and code files, then generates search.json, quick-ref.md, and glossary.md artifacts. index-docs automates this by scanning your docs/ and src/ directories, parsing Markdown and code exports, and producing cross-linked indexes under .claude/index/ for fast context lookup.

What's the fastest way to make documentation discoverable in a large project?

Indexing documentation creates a unified search layer that maps documentation to code references and keywords. index-docs config-driven loading parses your existing Markdown and code, extracts relevant sections, builds cross-references, and outputs structured indexes so you retrieve context instantly instead of hunting through files.

Can I index Markdown files and code together in one search?

Yes. index-docs indexes both documentation and source code simultaneously, producing separate docs-index.json and code-index.json artifacts plus a unified search.json. This enables cross-reference building between your Markdown docs and code exports, letting you search and retrieve results that link both formats together.

How does incremental refresh work with documentation indexing?

Incremental refresh updates only changed sections instead of re-indexing everything, reducing processing time on large projects. index-docs supports optional incremental refresh to detect updates in your docs/ and src/ and regenerate only affected indexes and metadata.json, speeding up iteration during active documentation work.

What file formats does documentation indexing support?

index-docs parses Markdown (via markdown-toc) and code exports, extracting sections and keywords from both. It works with YAML configuration for flexible loading, accepts code references and documentation as inputs, and produces structured JSON indexes, quick-reference Markdown, and glossary artifacts.

Is indexing practical for onboarding new team members to brownfield projects?

Yes. Indexing documentation and code accelerates onboarding by enabling fast context discovery and code-to-doc mapping. index-docs generates searchable indexes and quick-reference guides specifically for brownfield projects, letting new members retrieve relevant sections and code references instantly instead of navigating unorganized documentation.