* What is the problem? * My co-founder and I have both worked in large corporates like J.P. Morgan, Morgan Stanley, smaller companies like Palantir, and continuously see the issues that stem from unmaintained documentation.
Most codebases are under-documented, comments are sparsed, types aren't always obvious, and there's often a lot of knowledge that is forgotten as time goes on.
The deeper you go, the harder it gets to understand how things work. This slows down onboarding, wastes time during debugging, and increases the chance of things breaking.
Until today, we have been running pilots with small to medium sized companies and startups tweaking the product and gaining lots of feedback.
Today we want to open it up to the public with a release of the generation service!
* Try it out! * Go to https://docucod.com/oss and put your repository URL there. Once generated, the link will be visible.
You can also put the prefix url in front of the repo url: https://docucod.com/docs/<repo-url> (example: https://docucod.com/docs/https://github.com/clidey/whodb)
Please note this will work only for public repos up to 100MB.
How it works: Docucod analyzes the codebase, parses files, comments, types, examples, and the readme, then builds a static documentation site you can browse immediately — no config, no setup.
It tries to surface useful context automatically so you don’t have to read the code line by line to figure out what’s going on.
There is diagram generation with Mermaid, and we are working on generating images and later videos!
The publishing is done with our own static site builder called Dory ([https://github.com/clidey/dory](https://github.com/clidey/dory)).
It handles parsing, structure extraction, and HTML generation. Dory has been built with handling AI-generated MDX in mind, which is an interesting hurdle to overcome.
We're still fleshing it out, so PRs and feedback are very welcome.
What’s next: Right now we support public GitHub repos (private support coming). We’re also working on features like code search across the docs, customized responses based on the user's query, better navigation, theme customization, and integration with CI pipelines.
If you check it out, I’d really appreciate your feedback — both the good and the bad. Does it solve a real problem for you? What’s confusing, missing, or just not helpful?
Thanks!
1 comments