DocuBot is an AI-powered documentation tool that keeps your codebase in sync with its documentation. It plugs directly into your GitHub workflow and automatically updates your
documentation.md file when changes are pushed — so your docs evolve with your code, not after it.✨ Why It Matters
Documentation is a cornerstone of collaborative software development — but keeping it up-to-date is tedious and often forgotten. DocuBot tackles this by automating the process using a Large Language Model (LLM), freeing developers from the manual overhead and ensuring accurate, real-time documentation that grows with the project.
💡 What It Does
Auto-Generates Docs: Updates
documentation.md automatically when code changes.CI/CD Friendly: Works natively with GitHub Actions and fits right into your pipeline.
LLM-Powered: Uses AI to understand and document meaningful code updates.
Cloud Hosted: Runs serverlessly via AWS Lambda with fast, scalable execution.
Smart Commit: Commits updated docs only when actual changes are detected.
⚙️ How It Was Built
Architecture:
- Built using AWS Lambda for serverless execution
- Exposed via AWS API Gateway to handle requests from GitHub Actions
- Dockerized logic for documentation generation
- Uses a pre-trained LLM to analyze code diffs and write clear, structured markdown
Workflow:
- GitHub Actions detect file changes on push
- Changed files are sent to our API (via API Gateway)
- Lambda function processes the request and returns updated markdown
- The updated documentation is committed and pushed if there are changes
Scalability:
- Serverless architecture allows for high throughput with low cost
- Stateless, fast execution makes it suitable for active dev teams