About This Project
Overview
Github-Agent inspects a repository, detects its tech stack and core functionality, and generates a detailed, accurate README.md that it pushes back to GitHub automatically — built to keep documentation consistent across projects without the manual writing tax.
Motivation
I have too many repos with missing or stale READMEs, and writing them by hand is the kind of task I always deprioritize — so I built an agent to do it for me.
Lessons Learned
Getting the agent to correctly infer a project's purpose from its file structure alone, without me writing a summary first, took more iteration on the analysis prompt than I expected.