GenDocu | Devpost

Inspiration

As a developer, I often find myself skipping or delaying documentation for my projects. Many developers I've encountered have shared similar experiences, regretting that they didn't document their projects properly. Inspired by these experiences, I decided to create GenDocu! With this tool, you simply upload your code and optionally provide context about what your project is about—though providing context is optional, it can greatly enhance the quality of the documentation.

What it does

GenDocu automatically generates comprehensive documentation, including setup instructions and feature highlights. Currently, it offers two formats: GitHub README.md Format and Normal Text format. There's also a Copy to Clipboard option for easy copying of the generated documentation.

How I built it

I developed GenDocu using VS Code as the IDE. The backend is powered by Python's FastAPI framework, utilizing Meta's LLAMA 3.1 model through the Groq API. The user interface is built with HTML and CSS, while JavaScript handles fetching the documentation and copying it to the clipboard.

Challenges I ran into

One of the main challenges was formatting the text for the "Normal Text" documentation format. I also encountered difficulties deploying to Vercel and managing dependencies.

Accomplishments that I'm proud of

Honestly, I'm proud of everything! I'm particularly happy with the user interface and how well it understands the context of the code (Credit goes to Meta's LLAMA model).

What I learned

I learned a lot about prompt engineering to make the documentation more relevant, as well as formatting the text according to the user's preferences. I also picked up some new JavaScript skills!

What's next for GenDocu

I plan to integrate GitHub authentication and a version control system so users can select their repository and commit the generated documentation directly!