Skip to content

enoshdev/devdocs-ai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

7 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ€– DevDocs AI

Paste any Python function. Get instant explanation, docstring and improvement suggestions β€” powered by Groq LLaMA 3.1.

πŸ”— Live Demo

https://devdocs-ai.netlify.app

✨ Features

  • πŸ’‘ Plain English explanation of what your code does
  • πŸ“„ Auto-generated Google-style docstring
  • ⚑ 3 specific numbered improvement suggestions
  • πŸ“‹ One-click copy for generated docstring
  • ⌨️ Ctrl + Enter keyboard shortcut

πŸ›  Tech Stack

Layer Technology
Backend Python, FastAPI
AI Groq API β€” LLaMA 3.1
Frontend HTML, CSS, JavaScript
Deployment Hugging Face Spaces + Netlify

πŸš€ Run Locally

Backend

cd backend
pip install -r requirements.txt
python -m uvicorn main:app --reload

Frontend

Open frontend/index.html with Live Server in VS Code.

πŸ“ Project Structure

devdocs-ai/
  backend/
    main.py          # FastAPI app + Groq AI integration
    requirements.txt
    Dockerfile       # For Hugging Face deployment
  frontend/
    index.html       # Full UI with particle animations
  README.md

πŸ‘¨β€πŸ’» Author

Built by Enosh β€” IT undergrad at Vasavi College of Engineering, Hyderabad

GitHub

About

AI-powered tool that explains Python code, generates docstrings, and suggests improvements using Groq LLaMA 3.1

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors