Re:Show HN: I built an AI that turns GitHub codebases into e...
by amelius on Sunday April 20, 2025 @09:33AM
(#43743668)
I've said this a few times on HN: why don't we use LLMs to generate documentation? But then came the naysayers ...
[ Parent
| on HN ]
Re:Show HN: I built an AI that turns GitHub codebases into e...
by tdy_err on Sunday April 20, 2025 @11:26AM
(#43744382)
Alternatively, document your code.
Re:Show HN: I built an AI that turns GitHub codebases into e...
by cushychicken on Sunday April 20, 2025 @11:29AM
(#43744398)
Id have bought a lot of lunches for myself if I had a dollar for every time I’ve pushed my team for documentation and had it turn into a discussion of “Well, how does that stack up against other priorities?”
It’s a pretty foolproof way for smart political operators to get out of a relatively dreary - but high leverage - task.
AI doesn’t complain. It just writes it. Makes the whole task a lot faster when a human is a reviewer for correctness instead of an author and reviewer.
Re:Show HN: I built an AI that turns GitHub codebases into e...
by runeks on Sunday April 20, 2025 @12:28PM
(#43744780)
Useful documentation explains why the code does what it does. Ie. why is this code there?
An LLM can't magically figure out your motivation behind doing something a certain way.
Re:Show HN: I built an AI that turns GitHub codebases into e...
by johnnyyyy on Sunday April 20, 2025 @01:23PM
(#43745102)
Are you implying that only the creator of the code can write documentation?
Re:Show HN: I built an AI that turns GitHub codebases into e...
by oblio on Sunday April 20, 2025 @03:08PM
(#43745807)
No, they're saying that LLMs (and really, most other humans) can't really write the best documentation.
Frankly, most documentation is useless fluff. LLMs will be able to write a ton of that for sure :-)
Re:Show HN: I built an AI that turns GitHub codebases into e...
by bonzini on Monday April 21, 2025 @02:21AM
(#43748933)
Tell it the why of the API and ask it to write individual function and class docs then.
Re:Show HN: I built an AI that turns GitHub codebases into e...
by remoquete on Monday April 21, 2025 @08:29AM
(#43751203)
Because you can't. See my previous comment. https://news.ycombinator.com/item?id=43748908