skills.rest
AcidicSoil
AcidicSoilCOMMUNITY
Explore all skills by this author →
𝕏@d1rt7d4t4GitHub

index-docs

Index documentation and code into searchable JSON files under .claude/index.

1|Updated Oct 19, 2025
Search Tags:#documentation#context#indexing#search#code#knowledge-base#cross-references
One-click install
npx skills add https://github.com/AcidicSoil/lms-llmsTxt --skill index-docs-acidicsoil
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: index-docs
Source: https://github.com/AcidicSoil/lms-llmsTxt/tree/main/.claude/skills/index-docs
Command: npx skills add https://github.com/AcidicSoil/lms-llmsTxt --skill index-docs-acidicsoil

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Indexing and organizing documentation and codebases is challenging; this skill creates a centralized, searchable knowledge base to enable fast context lookup across brownfield projects.

Core Features & Use Cases

  • Automated indexing of Markdown docs and code exports into structured, searchable indexes.
  • Cross-referencing between documentation and code, plus generation of quick-ref and glossary artifacts.
  • Support for incremental refresh or full rebuild to keep indexes current.
  • Artifacts stored under .claude/index/ for downstream tasks and integrations.

Quick Start

Index an existing repository to generate a searchable index at .claude/index for 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 create a searchable knowledge base from my documentation and code?▼

A searchable knowledge base is created by scanning Markdown docs and code exports to build structured sections, keywords, and cross-references. This generates docs-index.json, code-index.json, and search.json artifacts for fast context lookup.

What is the best way to index a brownfield project for fast context lookup?▼

Indexing a brownfield project involves scanning existing docs/ and src/ directories to generate centralized index files. It builds cross-references between documentation and code, outputting artifacts to .claude/index for immediate context retrieval.

Can I incrementally refresh a documentation index without a full rebuild?▼

Incremental refresh of a documentation index is supported alongside full rebuild options. It scans updated docs/ and src/ files to keep the generated docs-index.json and code-index.json artifacts current without reprocessing the entire repository.

How does cross-referencing between documentation and code work?▼

Cross-referencing works by scanning docs/ and src/ to map relationships between Markdown documentation and code exports. It builds structural sections and keywords, linking the two into a unified search.json artifact for quick context lookup.

Does indexing documentation require any external dependencies?▼

Indexing documentation requires no external dependencies. It independently scans source directories and builds structured indexes, generating all necessary artifacts like quick-ref and glossary files directly under .claude/index.

Related Skills

Explore More Data & Analytics Skills→
evanfang0054evanfang0054
1

component-docs-batcher

Scan monorepo component directories and generate structured Markdown documentation.

Community
Advanced
adolfoaranaes12adolfoaranaes12
2

index-docs

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

Community
Advanced
Kushal9889Kushal9889

digital-brain

Manage personal brand, content, knowledge, relationships, and productivity with AI.

Community
Advanced
lev-oslev-os

lev-index

Manage LEANN vector indexes for semantic search via gRPC.

Official
Intermediate