Hey everyone! π
Super excited to finally share something Iβve been building over the past few weeks β Gitdocs AI.
π§ What is it?Gitdocs AI is a developer tool that analyzes the structure and content of a GitHub repository and generates a clean, professional README file using AI. It's designed to help devs ship better documentation without spending hours figuring out what to include or how to format it.
βοΈ How it works:- GitHub Integration: Users connect their repo, and the tool fetches metadata, file structure, and key code files.
- AI Analysis: It uses natural language generation (via locally run models or API-based, depending on setup) to generate a README draft with installation steps, usage instructions, features, and contribution guidelines.
- Customization Options: Users can tweak the tone (casual, professional, etc.) or focus areas (e.g., installation-heavy vs. feature-focused).
- One-Click Commit: The final README can be committed directly to the repo after review.
- Frontend: Next.js + Tailwind
- Backend: Node.js, Python (for AI processing), GitHub API
- Database: Supabase
- AI Integration: Custom prompt pipelines + optional Ollama local model support
README files are often overlooked, yet theyβre the first thing people see. As someone who jumps between side projects, I found myself procrastinating the docs every single time. This was my attempt to solve that friction point β for myself and maybe for others too.
Would love your thoughts, suggestions, or even tough love if you spot something I could improve.
Thanks for reading! π
No comments yet. Be the first to comment!