
I Got Tired of Writing Documentation. So I Built a Tool to Do It For Me.
Every project I ship has the same problem at the end. The code works. The tests pass. And then I have to write the README. Not a bad README — a real one. Architecture decisions, API endpoints, setup instructions, module breakdown. The kind of documentation that makes someone else's first hour with your codebase not a nightmare. I kept putting it off. Then I'd come back to my own projects two weeks later and spend 20 minutes remembering how my own code worked. So I built a tool to generate it automatically. What it does repo2docs points at a GitHub repo or a local directory and generates three documents: README.md — setup, usage, what the project does ARCHITECTURE.md — how the codebase is structured, entry points, module breakdown API.md — HTTP endpoints, routes, request/response shapes One command. Three documents. Done. # Point at a GitHub repo repo2docs https://github.com/owner/repository # Or a local directory repo2docs . # Custom output folder repo2docs ../my-service --output ./doc
Continue reading on Dev.to
Opens in a new tab



