skills.rest
ryanmiville
ryanmivilleCOMMUNITY
Explore all skills by this author →
GitHub

index-knowledge

Generate hierarchical AGENTS.md files with scoring-based location guidance.

Updated Dec 21, 2024
Search Tags:#automation#documentation#codebase#agents#AGENTS.md#knowledge-base
One-click install
npx skills add https://github.com/ryanmiville/dotfiles --skill index-knowledge-ryanmiville
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: index-knowledge
Source: https://github.com/ryanmiville/dotfiles/tree/main/home/.agents/skills/index-knowledge
Command: npx skills add https://github.com/ryanmiville/dotfiles --skill index-knowledge-ryanmiville

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the creation of a hierarchical AGENTS.md knowledge base for a codebase, enabling structured discovery and onboarding.

Core Features & Use Cases

  • Root + subdirectory AGENTS.md generation: Produce a central index plus depth-limited subdirectory documentation with scoring.
  • Parallel generation workflow: Spawn and merge multiple AGENTS.md files concurrently to speed up project-wide documentation.
  • Onboarding & maintenance: Simplify new contributor onboarding by surfacing conventions, patterns, and hotspots.

Quick Start

Run the index-knowledge skill to generate AGENTS.md for your repository and its critical submodules.

Frequently Asked Questions about index-knowledge

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

FAQPage Schema
How do I generate an AGENTS.md knowledge base for my codebase?▼

You need an AGENTS.md knowledge base to provide structured discovery and onboarding for a codebase, mapping conventions, patterns, and hotspots so new contributors can quickly understand project architecture.

How does parallel generation work for AGENTS.md files?▼

Parallel generation for AGENTS.md files works by spawning and merging multiple documentation files concurrently across subdirectories, speeding up project-wide documentation sprints and architecture reviews.

Can I limit the depth of subdirectory AGENTS.md generation?▼

Yes, you can limit the depth of subdirectory AGENTS.md generation because the skill produces depth-limited subdirectory documentation with scoring-based location guidance for critical submodules.

When should I use automated AGENTS.md generation over manual documentation?▼

Automated AGENTS.md generation is best used during project onboarding, architecture reviews, and documentation sprints when you need to rapidly map structure and complexity across a large codebase.

What is the AGENTS.md format used for in codebase onboarding?▼

The AGENTS.md format is used in codebase onboarding to serve as a hierarchical knowledge base, providing a central index plus subdirectory documentation that surfaces conventions and patterns.

Related Skills

Explore More Software Engineering Skills→
alex-voloshin-devalex-voloshin-dev
2

project-init

Scan project directories to identify tech stacks and generate AGENTS.md, ARCHITECTURE.md, and TESTING.md files.

Community
Advanced
magozmagoz
2

index-knowledge

Generate hierarchical AGENTS.md documentation with complexity-scored subdirectories.

Community
Advanced
kjanatkjanat

index-knowledge

Generate hierarchical AGENTS.md knowledge bases with complexity-scored subdirectory documentation.

Community
Advanced
nielpattinnielpattin

index-knowledge

Generate hierarchical AGENTS.md knowledge bases from codebase structure and complexity.

Community
Advanced