←back to thread

Show HN: I built an AI that turns GitHub codebases into easy tutorials

(github.com)
923 points zh2408 | 1 comments | 19 Apr 25 21:04 UTC | HN request time: 0.205s | source
Show context
bilalq ◴[20 Apr 25 04:48 UTC] No.43741590[source]▶
This is actually really cool. I just tried it out using an AI studio API key and was pretty impressed. One issue I noticed was that the output was a little too much "for dummies". Spending paragraphs to explain what an API is through restaurant analogies is a little unnecessary. And then followed up with more paragraphs on what GraphQL is. Every chapter seems to suffer from this. The generated documentation seems more suited for a slightly technical PM moreso than a software engineer. This can probably be mitigated by refining the prompt.

The prompt would also maybe be better if it encouraged variety in diagrams. For somethings, a flow chart would fit better than a sequence diagram (e.g., a durable state machine workflow written using AWS Step Functions).

replies(4): >>43741600 #>>43743287 #>>43746793 #>>43764213 #
1. neop1x ◴[22 Apr 25 17:03 UTC] No.43764213[source]▶
>> This can probably be mitigated by refining the prompt

Sometimes it explains things like I am a child and sometimes it doesn't explain things well enough. I think fixing this just by a simple prompt change won't work - it may fix it in one part and make things worse in the other part. This is a problem which I have with LLM: you can fine-tune the prompt for a specific case but I find it difficult to write a universally-working prompt. The problem seems to be LLM "does not understand my intents", like it can't deduce what I need and "proactively" help. It follows requirements from the prompt but the prompt has to (and can't) handle all situations. I am getting tired of LLM.