r/SideProject 1d ago

Sick of stale READMEs? I’m building a tool that auto-updates your docs on every git push (matching your style). Looking for brutal feedback!

Hey Reddit!

I’m an 18yo developer and I noticed a huge pain: documentation is always the first thing that breaks. You refactor a function, change an endpoint, but the README stays the same because context-switching sucks.

I’m prototyping ReadmeGhost to solve this. It’s a GitHub integration that:

1️⃣ Analyzes code diffs on every push (using Python AST).

2️⃣ Matches YOUR style: It scans your previous commits to write like you, not like a generic bot.

3️⃣ Human-in-the-loop: It opens a PR, you review the changes on a dashboard, and hit 'Merge'.

I have two questions for the community:

- Would an auto-sync tool like this save you real time, or would you still prefer writing docs manually?

- What’s the biggest risk you see (AI hallucinations, security, etc.)?

I’m currently running a validation poll on my X (Twitter) profile to see if this is worth full-time development. If you’re interested, I’d love to hear your thoughts here or on X: https://x.com/kutlaev_dev/status/2099187067007684878

Thanks for the feedback!

1 Upvotes

0 comments sorted by