codedocs

Generate AI-friendly documentation with index, overview, and module docs from repository sources.

1|Updated Mar 9, 2026
One-click install
npx skills add https://github.com/LuminairPrime/openwrt-docs4ai-pipeline --skill codedocs-luminairprime
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: codedocs
Source: https://github.com/LuminairPrime/openwrt-docs4ai-pipeline/tree/main/.agents/skills/codedocs
Command: npx skills add https://github.com/LuminairPrime/openwrt-docs4ai-pipeline --skill codedocs-luminairprime

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Automatically generate AI-friendly documentation for a codebase to help AI agents and developers understand structure, dependencies, and usage without reading raw code.

Core Features & Use Cases

  • Automatic tech-stack identification and module boundary detection across monorepos and polyglot repos.
  • Production-ready docs pipeline that outputs OVERVIEW.md, module docs, patterns, INDEX.md, and a .codedocs.json manifest.
  • Incremental updates with diff-based re-generation and targeted module refresh when source changes occur.

Quick Start

Install and run the skill against your repository to generate the full documentation surface.

Frequently Asked Questions about codedocs

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

FAQPage Schema
How do I generate AI-friendly documentation for my codebase?

Generating AI-friendly codebase documentation involves orchestrating discovery and module mapping to output a searchable, multi-layered docs suite. This creates an index, overview, and module documents from repository sources for AI agents.

Can I automatically map modules across a polyglot monorepo?

Yes, you can automatically map modules across a polyglot monorepo. The documentation pipeline detects tech-stack boundaries and generates targeted module documentation to help AI agents understand structure and dependencies without reading raw code.

How do I incrementally update codebase documentation after source changes?

You can incrementally update codebase documentation using diff-based re-generation. When source changes occur, the tool performs targeted module refresh to keep the documentation suite and JSON manifest current without regenerating everything.

What is a .codedocs.json manifest and why does an AI agent need it?

A .codedocs.json manifest is a structured file generated alongside an INDEX.md to provide AI agents with a searchable map of a codebase. It helps agents quickly understand structure, dependencies, and cross-cutting patterns without parsing raw code.

Does automated codebase documentation work without any external dependencies?

Yes, automated codebase documentation can work without external dependencies. The tool independently orchestrates repository discovery, module boundary detection, and pattern documentation to generate the full documentation surface from source files.