News for hackers. Stuff that matters.

Show HN: GitHub tool to generate and update code documentation automatically

https://www.supacodes.com/

Hi guys!

While working in teams, internal documentation is important. But the problem is, writing it takes much time. It doesn't end there, keeping them up-to-date is a big deal as well.

I built this simple tool that analyzes your codebase and automatically generates documentation right into your Github repo. Whenever you make a new commit, it analyzes the updates and modifies the existing docs to keep them up-to-date.

That means, you don't need to spend time struggling with docs again. And, the new hire won't stare at the senior for that huge undocumented codebase. It works for any team size, so scalable for startups and agencies.

I launched this a few weeks ago and it has already improved a lot with all the feedback from people. I am building this in public, so you can see my progress on twitter too.

I would love to know your thoughts on this! Any suggestions or feedback would be highly appreciated!

( 3 comments | 4 points | on HN )
Re:Show HN: GitHub tool to generate and update code document... by minhdanh72 on Monday April 29, 2024 @05:16PM (#40204224)
This is very interesting. Would love to try it but Dart/Flutter is not yet supported
Re:Show HN: GitHub tool to generate and update code document... by madcoderme on Monday April 29, 2024 @11:38PM (#40206978)
I will let you know when it's supported!
Re:Show HN: GitHub tool to generate and update code document... by madcoderme on Sunday May 05, 2024 @04:53AM (#40263254)
Hey, Dart is now supported