skills.rest
ajoslin
ajoslinCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

index-knowledge

Generate AGENTS.md documentation at root and subdirectories with complexity scoring.

24|7|Updated Oct 28, 2014
Search Tags:#automation#documentation#onboarding#codebase#knowledge-base#agents-md
One-click install
npx skills add https://github.com/ajoslin/dot --skill index-knowledge-ajoslin
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: index-knowledge
Source: https://github.com/ajoslin/dot/tree/main/config/opencode/skills/index-knowledge
Command: npx skills add https://github.com/ajoslin/dot --skill index-knowledge-ajoslin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically creates a hierarchical AGENTS.md knowledge base for a codebase, organizing root and scoped subdirectory documentation with complexity scoring.

Core Features & Use Cases

  • Generates AGENTS.md at root and per-subdirectory docs with complexity scoring.
  • Analyzes project structure, existing AGENTS.md references, and code symbols to decide where to place documentation and how to structure it.
  • Use Case: A developer wants quick onboarding by accessing high-level architecture docs and per-module details.

Quick Start

Run the knowledge-base generator to produce AGENTS.md files across the repository.

Frequently Asked Questions about index-knowledge

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

FAQPage Schema
How do I generate a knowledge base for my codebase to improve onboarding?▼

Generate a codebase knowledge base by creating structured AGENTS.md documents at the root and selected subdirectories. The tool analyzes project structure, existing references, and code symbols to organize documentation with complexity-aware scoring for developer onboarding.

What is an AGENTS.md file and when do I need it for my repository?▼

An AGENTS.md file provides structured, hierarchical documentation for a repository. You need it when onboarding developers who require high-level architecture docs and per-module details to navigate complex project structures quickly.

How to automatically create hierarchical documentation for subdirectories in a codebase?▼

Automatically create hierarchical documentation by running the knowledge-base generator, which analyzes project structure and code symbols to place AGENTS.md files at the root and scoped subdirectories based on complexity-aware scoring.

Do I need LSP data to generate codebase documentation with complexity scoring?▼

LSP data is optional for generating codebase documentation. The tool can optionally leverage LSP data for symbol density and central exports, but it primarily parses existing files and project structure to determine documentation placement.

What's the best way to document code symbols and project structure for AI agents?▼

The best way to document code symbols for AI agents is generating AGENTS.md files that synthesize project structure and central exports. This approach uses complexity-aware scoring to structure documentation hierarchically across the codebase.

Related Skills

Explore More Software Engineering Skills→
simorgh3196simorgh3196
1

rust-symbol-analyzer

Analyze Rust codebases to expose a structured symbol map via LSP.

Community
Intermediate
tursodatabasetursodatabase
23.8k

index-knowledge

Generate hierarchical AGENTS.md knowledge bases with complexity-based scoring from repository structure.

Official
Advanced
sustinbebustinsustinbebustin

index-knowledge

Generate hierarchical CLAUDE.md knowledge base files with complexity-scored subdirectory documentation.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate