AI-powered tool to generate useful documentation directly from your codebase.
Streamline your workflow and focus on shipping – not writing endless docs.
-
📄 Function-level documentation
Generate concise, readable explanations for your code functions and methods. -
🌐 API endpoint docs
Parse your backend routes and generate developer-friendly API documentation. -
🗃️ Database schema docs
Understand and document your database models in plain English. -
📝 Project README generation (New)
Auto-generate a clean README with tech stack, setup steps, and project description. -
📊 Architecture diagrams (New)
Get visual insights into your code structure or API flow.
Writing docs is time-consuming and often gets skipped.
Code2Docs uses AI to generate clean, helpful documentation from your existing code — saving you hours while improving team collaboration and project maintainability.
Built for:
- Solo devs & indie hackers 🧑💻
- Teams with growing codebases 📈
- Anyone who hates writing README files 😅
🕰️ What We Previously Built
Before pivoting to the CLI, Code2Docs was originally a web-based SaaS platform. It offered similar core features with a visual interface for generating and managing documentation.
🎥 Demo of the legacy web version:
Watch on YouTube
🗃️ Legacy repository (archived):
github.com/xKarinSan/Code2Docs-legacy
We learned a lot from the initial version — especially around dev workflows and where automation adds real value — which led to the current CLI pivot.
- 💬 Join our Discord Channel
- 📘 View the CLI README and Setup Guide
- 🌐 Visit our Landing Page
- 🔗 Follow us on LinkedIn
We welcome contributions from developers of all levels! Whether it’s fixing a bug, adding a feature, or improving documentation — every bit helps.
🐞 Report bugs or issues Found something broken? Please open an issue to let us know.
💡 Suggest new features or improvements Got an idea to make Code2Docs better? We'd love to hear it — open a feature request!
🌟 Submit code contributions From small tweaks to new capabilities, pull requests are always welcome.
🧼 Refactor or clean up code Notice repeated logic, outdated patterns, or unnecessary complexity? Help us:
- Improve readability and maintainability
- Break large functions into smaller, testable pieces
- Organize code into clearer module structures
- Remove unused imports or dead code
📝 Improve existing documentation Good docs are everything! You can contribute by:
- Clarifying CLI usage examples
- Improving descriptions of features
- Fixing typos, formatting, or broken links
- Adding FAQs or setup troubleshooting tips
🧪 Write or enhance tests Help increase reliability and prevent regressions by:
- Adding tests for uncovered features
- Improving test coverage for edge cases
- Refactoring flaky or redundant tests
- Suggesting improvements to test structure or tooling
-
Fork the repository Click the Fork button on GitHub and clone your fork locally:
git clone https://github.com/your-username/Code2Docs.git
-
Install dependencies Follow the setup guide in the CLI README.
-
Create a new branch Use a descriptive name:
git checkout -b feature/add-api-doc-support
-
Make your changes and commit:
git commit -m "Commit message" -
Push and create a PR Push your branch and open a pull request on the main repo:
git push origin feature/add-api-doc-support
- Open an issue for any bug reports or feature requests — even before submitting a PR.
- Keep commits focused and descriptive.
- Follow existing code style and structure.
- Link related issues in your PR description if applicable.
- Be kind and respectful — we’re all here to learn and build together!
🛠️ NOTE: This repository is under construction!