index-knowledge

Generate a hierarchical AGENTS.md knowledge base with complexity-scored subdirectories.

1|Updated Jun 8, 2024
One-click install
npx skills add https://github.com/michaelmechenko/dotfiles --skill index-knowledge-michaelmechenko
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: index-knowledge
Source: https://github.com/michaelmechenko/dotfiles/tree/main/opencode/skill/index-knowledge
Command: npx skills add https://github.com/michaelmechenko/dotfiles --skill index-knowledge-michaelmechenko

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Index-knowledge automates the creation of a navigable AGENTS.md knowledge base for a codebase, producing a root document plus complexity-scored subdirectory docs to improve project understanding and onboarding.

Core Features & Use Cases

  • Root and subdirectory AGENTS.md generation to document project structure and conventions.
  • Score-driven placement: decide where to create or update AGENTS.md based on directory complexity.
  • Template-driven output: root and subdir AGENTS.md follow consistent formats and quality gates.
  • Parallel generation and review: publish in batches while ensuring deduplication and style guidelines.
  • Works across multi-language codebases and evolving repositories.

Quick Start

Run the index-knowledge skill against your codebase to generate a root AGENTS.md and scored subdirectory AGENTS.md files.

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 against your codebase to produce a root document and complexity-scored subdirectory docs. It automates project understanding by creating navigable documentation across multi-level structures.

What is a complexity-scored subdirectory document?

A complexity-scored subdirectory document is an AGENTS.md file generated based on directory complexity. The index-knowledge skill evaluates your codebase structure to decide where to create or update these docs, ensuring documentation is placed where it is most needed.

How does template-driven codebase documentation work?

Template-driven codebase documentation uses predefined formats to generate root and subdirectory AGENTS.md files. The index-knowledge skill enforces consistent outputs and quality gates, ensuring structured and reusable documentation across your evolving repositories.

Can I generate documentation for multi-language codebases?

Yes, you can generate documentation for multi-language codebases. The index-knowledge skill works across evolving repositories, applying score-driven placement and parallel generation to produce structured AGENTS.md files regardless of the languages used.

Do I need YAML frontmatter to generate AGENTS.md files?

Yes, YAML frontmatter is required in the root SKILL.md for discovery. The index-knowledge skill uses this frontmatter to drive the discovery phase and initiate the generation of your hierarchical AGENTS.md knowledge base.

What are the limitations of automated codebase documentation generation?

Automated codebase documentation generation requires YAML frontmatter for discovery and relies on directory complexity scoring to place files. It may require review phases to ensure deduplication and adherence to style guidelines across parallel generation batches.