Every time I start a new project, I tell myself, “I’ll document this properly from the beginning,” and then three months later I’m staring at a README with a single line that says “TODO: Write documentation.”.
Eventually I got tired of that loop and started tinkering with a script to help me out. The tinkering snowballed into Wiki Bot, a little assistant that reads a repository and spits out GitHub wiki pages. Just started working on it, but it’s been surprisingly handy.
Basically you just point it to your repo, let it crawl through the files, spot the architectural patterns, and assemble documentation that feels coherent. Under the hood there’s a multi-phase workflow—repository analysis, architectural mapping, and per-component write-ups—but conceptually it’s just “give the bot context and see what it learns.”
I particularly like logic flow charts to understand how something works, and turns out LLMs can just generate those for you. Right now, it just does that on the Architecture page, but will expand that to the functional areas soon.
It’s still a side project, so there are rough edges and knobs to turn. Out of the box it leans on the Anthropic Claude Agent SDK, but you can swap in other LLM providers if that’s better for your wallet or stack. For instance if you have a claude or codex subscription it supports wrapping the respective cli programs.
Just clone the repo, set an API key or the LLM_PROVIDER env var, point it at a codebase, and let it cook. It skips generated files, respects the gitignore, and drops markdown files you can push straight into a GitHub wiki.
I’ve started pointing it at new repos as they spin up. I still proofread what it produces, but it’s a lot easier to tweak an auto-generated wiki than to conjure one from scratch at 1 a.m.
There’s plenty left on the roadmap. Next up is doing CI hooks that regenerate docs from diffs and nudge pull requests when documentation lags behind code. I also want to tweak how it handles large repos (iterative approach).
Even in this early state, it nudges me from “zero documentation” to “something decent” without the usual procrastination tax. If that sounds useful, give it a spin and let me know where it falls over.
Check out the project: github.com/Chris-Cullins/wiki_bot