index-knowledge

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

2|Updated Jun 23, 2022
One-click install
npx skills add https://github.com/magoz/.dotfiles --skill index-knowledge-magoz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: index-knowledge
Source: https://github.com/magoz/.dotfiles/tree/main/opencode/.config/opencode/skill/index-knowledge
Command: npx skills add https://github.com/magoz/.dotfiles --skill index-knowledge-magoz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate a hierarchical AGENTS.md knowledge base for a codebase, enabling consistent documentation, onboarding, and knowledge transfer across root and subdirectories.

Core Features & Use Cases

  • Root + depth-scored subdirectory AGENTS.md generation for project-wide knowledge organization.
  • Ingest existing AGENTS.md insights to preserve valuable context while regenerating.
  • Guided placement of documentation by scoring and domain boundaries to minimize duplication.

Quick Start

Run the index-knowledge skill to generate a root AGENTS.md and depth-limited subdirectory AGENTS.md documentation for the project.

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?▼

To generate an AGENTS.md knowledge base, run the index-knowledge skill to automatically create a root document and depth-scored subdirectory files, surfacing onboarding notes and conventions for your codebase.

What is the best way to document codebase conventions for agent onboarding?▼

The best way to document codebase conventions is to generate hierarchical AGENTS.md files that score directory complexity and surface anti-patterns, ensuring consistent knowledge transfer for agent onboarding.

Can I preserve existing AGENTS.md insights when regenerating codebase documentation?▼

Yes, you can preserve existing AGENTS.md insights because the generation process ingests current context to integrate valuable information while regenerating update-aware documentation across the project.

How does directory complexity scoring work for codebase knowledge organization?▼

Directory complexity scoring works by evaluating domain boundaries to guide the placement of depth-limited subdirectory AGENTS.md documentation, minimizing duplication and enabling quick navigation across modules.

Does generating hierarchical documentation work for multi-module projects of varying sizes?▼

Yes, generating hierarchical documentation applies across multi-module projects of varying sizes, creating a root AGENTS.md and parallel subdirectory files to organize project-wide knowledge consistently.

When should I avoid using automated codebase documentation generation?▼

You should avoid automated codebase documentation generation if your project lacks clear domain boundaries, as scoring relies on directory structure to place documentation accurately and prevent knowledge duplication.