llm-wiki
llm-wiki creates and updates a structured markdown documentation system for any codebase, storing it in a `.llm-wiki/` directory at your project root. It handles reconnaissance, skeleton generation, article writing, cross-linking, and linting—letting humans direct while the LLM manages the bookkeeping. The wiki compounds over time as your codebase evolves, capturing architecture, modules, concepts, APIs, and guides in an interlinked format.
llm-wiki builds and maintains a structured markdown wiki that documents your codebase's architecture, modules, and APIs in a `.llm-wiki/` directory.
AI-generated summary based on this skill's SKILL.md
Install
staruhub/ClaudeSkills/llm-wiki · repository language: Python
git clone https://github.com/staruhub/ClaudeSkills
cp -r ClaudeSkills/llm-wiki ~/.claude/skills/llm-wikiFrequently asked questions
AI-generated answers based on this skill's SKILL.md and metadata
How do I build a wiki for my codebase?
llm-wiki creates a structured markdown documentation system stored in a `.llm-wiki/` directory at your project root. It handles reconnaissance of your source code, generates a skeleton structure, writes articles on architecture and modules, cross-links them, and lints the output—all while letting you direct the process. The wiki compounds over time as your codebase evolves.
Can llm-wiki generate documentation from source code automatically?
Yes. llm-wiki analyzes your codebase and uses LLM generation to produce documentation covering architecture, modules, concepts, and APIs. It creates interlinked markdown articles with code examples and diagrams, building a persistent knowledge base that captures your project structure without manual documentation overhead.
How does llm-wiki update existing wiki content?
llm-wiki detects changes in your source code and updates the existing wiki accordingly. Rather than starting from scratch, it maintains your `.llm-wiki/` directory structure and refreshes articles as your codebase evolves, keeping documentation synchronized with your project.
What format does llm-wiki use for documentation?
llm-wiki generates cross-linked markdown documentation stored in your project's `.llm-wiki/` directory. The output includes structured articles on modules, APIs, and architecture, with code examples and diagrams embedded, all organized for easy team collaboration and version control.
How can I use llm-wiki to understand an unfamiliar codebase?
llm-wiki analyzes unfamiliar source code and generates LLM-powered documentation that explains the project structure, key modules, and APIs. This lets you quickly grasp architecture and concepts without reading raw code, making onboarding and knowledge transfer faster for your team.
Is llm-wiki suitable for team collaboration?
Yes. llm-wiki creates a persistent, version-controlled knowledge base stored in your repository's `.llm-wiki/` directory. Your team can collaborate on the wiki, track changes over time, and maintain a shared understanding of codebase architecture and design as the project evolves.
SKILL.md
rendered from the published skill — quoted content, verbatim
LLM Wiki for Codebases
Build a persistent, interlinked markdown wiki that captures the architecture, modules, patterns, and APIs of a codebase. The wiki lives in .llm-wiki/ at the project root. Humans curate and direct; the LLM handles all bookkeeping.
Based on Andrej Karpathy's LLM Wiki pattern: raw sources are "compiled" into a structured wiki that compounds over time.
Mode Detection
Determine the mode based on current state:
- No
.llm-wiki/directory exists -> Full Build mode .llm-wiki/exists -> Update mode (diff and refresh)
Full Build Workflow
Phase 1: Reconnaissance
- Read top-level files: README,
(truncated - see the full file via the links below)
Read as markdown · JSON record · Browse the source repository
File tree — 3 files
llm-wiki/SKILL.md
llm-wiki/references/article-templates.md
llm-wiki/references/wiki-schema.md