index-knowledge

Generate hierarchical AGENTS.md files for codebase roots and subdirectories.

Updated Jun 22, 2024
One-click install
npx skills add https://github.com/Dyrean/dotfiles --skill index-knowledge-dyrean
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: index-knowledge
Source: https://github.com/Dyrean/dotfiles/tree/main/pi/.pi/agent/skills/index-knowledge
Command: npx skills add https://github.com/Dyrean/dotfiles --skill index-knowledge-dyrean

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generate a structured, hierarchical AGENTS.md knowledge base for a codebase, enabling consistent documentation, onboarding, and governance.

Core Features & Use Cases

  • Root knowledge base: Creates a root AGENTS.md summarizing project structure and conventions.
  • Subdirectory reports: Generates AGENTS.md for key subdirectories with scoped content and deduplication.
  • Quality gates: Enforces concise, telegraphic style and trimming rules to keep docs focused.
  • Use Case: Large monorepos benefit from consistent, navigable documentation for developers and reviewers.

Quick Start

Run the knowledge-base generator to build AGENTS.md for the repository root and selected subdirectories.

Frequently Asked Questions about index-knowledge

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

FAQPage Schema
How do I create a hierarchical AGENTS.md knowledge base for my codebase?

To create a hierarchical AGENTS.md knowledge base, this Skill analyzes your codebase structure, entry points, and conventions to generate a root document and scoped subdirectory documentation. It scores directory complexity to ensure generated AGENTS.md files contain location-specific content.

What is the best way to document multi-module projects for onboarding and governance?

Documenting multi-module projects for onboarding is best achieved by generating a hierarchical AGENTS.md structure. This approach discovers project conventions and anti-patterns, producing navigable root and subdirectory reports that enforce consistent documentation and governance across large monorepos.

Can I automatically generate code documentation for complex subdirectories in a monorepo?

Yes, you can automatically generate code documentation for complex monorepo subdirectories. The Skill runs a discovery and scoring phase to evaluate directory complexity, then produces scoped AGENTS.md files with deduplicated content tailored to specific locations within the project.

How does AGENTS.md generation handle existing documentation and anti-patterns?

AGENTS.md generation handles existing documentation by analyzing your current AGENTS.md file during a discovery phase. It identifies project anti-patterns and build/test patterns, then applies quality gates to generate concise, telegraphic-style documents that enforce trimming rules and keep docs focused.

Does AGENTS.md code documentation work without external dependencies?

Yes, AGENTS.md code documentation generation works without external dependencies. The Skill operates independently to discover your repository structure and generate hierarchical knowledge base files, requiring no additional components or external libraries to produce the root and subdirectory documents.