Get started
Introduction
Point DeepDoc at a repository and get a documentation site you can brand, theme and ship.
DeepDoc reads a codebase and writes the documentation site you would have written yourself. It groups pages by domain, ships a search box and an optional chatbot that cites real files, and then keeps the whole thing current as your code changes.
The shape of it
Point it at your repo. deepdoc init writes a .deepdoc.yaml.
Generate. DeepDoc scans the code, plans a structure and writes Markdown. This is the only step that spends LLM tokens, apart from update.
Make it yours. Set colours, logo and navigation. They apply on the next deepdoc serve, with no regeneration and no further LLM calls.
Ship it. deepdoc deploy produces a static site for any host.
Keep it current. deepdoc update diffs against your last synced commit and regenerates only the pages that changed.
What it supports
Endpoint, runtime and call-graph analysis cover Python (Django, Django REST Framework, FastAPI, Falcon), JavaScript and TypeScript (Express, Fastify, NestJS), PHP (Laravel) and Go. Vue components are parsed for symbols. Other languages may parse but are not fully supported, and DeepDoc prints a warning when it finds source it cannot analyse.