Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 1.26 KB

File metadata and controls

21 lines (17 loc) · 1.26 KB

CodeWiki

Guides

Hand-written guides for CodeWiki 2.0. The docs/ folder next to this one is CodeWiki's own generated documentation and is not edited by hand.

Guide Read it when you want to
CLI reference Look up any codewiki generate or codewiki config flag
Providers and models Connect an API key, Atlas Cloud, Azure, Bedrock, or run on a Claude / Codex subscription
Artifact-aware generation Understand how build, CI, container, and config files get documented, and how to tune or turn it off
Incremental updates Keep documentation current with --update and understand what it will and will not touch
MCP / IDE-driven mode Run CodeWiki as an MCP server inside Cursor, Claude Desktop, Claude Code, or CodeBuddy, with no LLM configuration
Development guide Change CodeWiki: project layout, pipeline, adding a language, tests, releasing
Docker setup Run the web application in a container

Also at the top level: CHANGELOG, SECURITY, LICENSE.