Live data from Hacker News

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

github.com

131–140 of 181 posts

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

#131
post #34

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 mor…

Answers like this are sort of what makes me wonder what most engineers are smoking when they think AI isn’t valuable. I don’t think the outright dismissal of AI is smart. (And, OP, I don’t mean to imply that you are doing that. I mean this generally.) I also suspect people who level these criticisms have never really used a frontier LLM. Feeding in a whole codebase that I’m familiar with, and hearing the LLM give goo…

Many devs still think their job is to write code not build products their business needs. I use LLMs extensively and it’s helped me work better faster.

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

#132
post #95

I had not used gemini before, so spent a fair bit of time yak shaving to get access to the right APIs and set up my Google project. (I have an OpenAPI key but it wasn't clear how to use that service.) I changed it to use this line: api_key=os.getenv("GEMINI_API_KEY", "your-api_key") instead of the default project/location option. and I changed it to use a different model: model = os.getenv("GEMINI_MODEL", "gemini-2.5…

If you want to see what output looks like (for smaller projects--the OP shared some for other, more popular projects), I posted a few of the tutorials to my GitHub: https://github.com/mooreds/prime-mvc-tutorial https://github.com/mooreds/railsquickstart-tutorial https://github.com/mooreds/fusionauth-jwt-tutorial/ Other than renaming the index.md file to README.md and modifying it slightly, I made no changes. Edit: ad…

Update, billing was delayed, but for 4 tutorials it cost about $5.

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

#133
post #34

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 mor…

Answers like this are sort of what makes me wonder what most engineers are smoking when they think AI isn’t valuable. I don’t think the outright dismissal of AI is smart. (And, OP, I don’t mean to imply that you are doing that. I mean this generally.) I also suspect people who level these criticisms have never really used a frontier LLM. Feeding in a whole codebase that I’m familiar with, and hearing the LLM give goo…

> Answers like this are sort of what makes me wonder what most engineers are smoking when they think AI isn’t valuable.

Honestly, I wonder if I'm living in some parallel universe, because my experience is that "most engineers" are far from that position. The reactions I'm seeing are either "AI is the future" or "I have serious objections to and/or problems with AI".

If you're calling the latter group "the outright dismissal of AI", I would disagree. If I had to call it the outright dismissal of anything, it would be of AI hype.

> I also suspect people who level these criticisms have never really used a frontier LLM.

It's possible. At my workplace, we did a trial of an LLM-based bot that would generate summaries for our GitHub PRs. I have no idea whether it's a "frontier" LLM or not, but I came out of that trial equally impressed, disappointed, and terrified.

Impressed, because its summaries got so many details right. I could immediately see the use for a tool like that: even when the PR author provides a summary of the PR, it's often hard to figure out where to start looking at the PR and in which order to go through changes. The bulleted list of changes from the bot's summary was incredibly useful, especially because it was almost always correct.

Disappointed, because it would often get the most important thing wrong. For the very first PR that I made, it got the whole list of changes right, but the explanation of what the PR did was the opposite of the truth. I made a change to make certain behavior disabled by default and added an option to enable it for testing purposes, and the bot claimed that the behavior was impossible before this change and the PR made it possible if you used this option.

Terrified, because I can see how alluring it is for people to think that they can replace critical thinking with AI. Maybe it's my borderline burnout speaking, but I can easily imagine the future where the pressure from above to be more "efficient" and to reduce costs brings us to the point where we start trusting faulty AI and the small mistakes start accumulating to the point where great damage is done to millions of people.

> Even if the LLM never writes a line of code - this is still valuable, because helping humans understand software faster means you can help humans write software faster.

I have my doubts about this. Yes, if we get an AI that is reliable and doesn't make these mistakes, it can help us understand software faster, as long as we're willing to make the effort to actually understand it, rather than delegating to the AI's understanding.

What I mean by that is that there are different levels of understanding. How deep do you dive before you decide it's "deep enough" and trust what the AI said? This is even more important if you start also using the AI to write the code and not just read it. Now you have even less motivation to understand the code, because you don't have to learn something that you will use to write your own code.

I'll keep learning how to use LLMs, because it's necessary, but I'm very worried about what we seem to want from them. I can't think of any previous technological advance that aimed to replace human critical thinking and creativity. Why are we even pursuing efficiency if it isn't to give us more time and freedom to be creative?

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

#134

Earlier quoted context omitted.

Answers like this are sort of what makes me wonder what most engineers are smoking when they think AI isn’t valuable. I don’t think the outright dismissal of AI is smart. (And, OP, I don’t mean to imply that you are doing that. I mean this generally.) I also suspect people who level these criticisms have never really used a frontier LLM. Feeding in a whole codebase that I’m familiar with, and hearing the LLM give goo…

Many devs still think their job is to write code not build products their business needs. I use LLMs extensively and it’s helped me work better faster.

LLMs excel at some things and work very poorly at others. People working on different problems have had different experiences, sometimes opposite ends of the spectrum.

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

#135
post #34

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 mor…

Answers like this are sort of what makes me wonder what most engineers are smoking when they think AI isn’t valuable. I don’t think the outright dismissal of AI is smart. (And, OP, I don’t mean to imply that you are doing that. I mean this generally.) I also suspect people who level these criticisms have never really used a frontier LLM. Feeding in a whole codebase that I’m familiar with, and hearing the LLM give goo…

>Answers like this are sort of what makes me wonder what most engineers are smoking when they think AI isn’t valuable.

I'll just wait for a winner to shake out and learn that one. I've gotten tired of trying AIs only to get slop.

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

#137

Woah, this is really neat. My first step for many new libraries is to clone the repo, launch Claude code, and ask it to write good documentation for me. This would save a lot of steps for me!

Exactly what I did today! (for Codex!) The output here is actually slightly better!

I bet in the next few months we'll be getting dynamic, personalized documentation for every library!! Good times

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

#138
How well does this work on unknown code bases?

The tutorial on requests looks uncanny for being generated with no prior context. The use cases and examples it gives are too specific. It is making up terminology, for concepts that are not mentioned once in the repository, like "functional api" and "hooks checkpoints". There must be thousands of tutorials on requests online that every AI was already trained on. How do we know that it is not using them?

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

#139
post #94
post #86

This is neat, but I did find an error in the output pretty quickly. (Disregard the mangled indentation) # Use the Session as a context manager with requests.Session() as s: s.get('https://httpbin.org/cookies/set/contextcookie/abc') response = s.get(url) # ??? print("Cookies sent within 'with' block:", response.json()) https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Req...

If only the AI could explain the errors that the AI outputs.

Cannot you stuff the snakes tail into its mouth?

I tried this for some very small decompilation projects, and it was cute at best.

Then I sent it a boot loader. I should have posted it on a ceral box for better results.

Is someone going to suggest that I check the dissembly into git hub and watch it make a tutorial?

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

#140

Earlier quoted context omitted.

Answers like this are sort of what makes me wonder what most engineers are smoking when they think AI isn’t valuable. I don’t think the outright dismissal of AI is smart. (And, OP, I don’t mean to imply that you are doing that. I mean this generally.) I also suspect people who level these criticisms have never really used a frontier LLM. Feeding in a whole codebase that I’m familiar with, and hearing the LLM give goo…

> Answers like this are sort of what makes me wonder what most engineers are smoking when they think AI isn’t valuable. Honestly, I wonder if I'm living in some parallel universe, because my experience is that "most engineers" are far from that position. The reactions I'm seeing are either "AI is the future" or "I have serious objections to and/or problems with AI". If you're calling the latter group "the outright di…

The value is that it got the details correct as you admit. That alone is worth the price of admission. Even if I need to rewrite or edit parts it has saved me time, and has raised the quality of PRs being submitted across the board. The key point with these tools is *Accountability*. As an engineer you are still accountable for your work. Using any tool doesn't take that away. If the PR tool gets it wrong, and you still submit it, that on the engineer. If you have a culture of accountability, then there is nothing to be terrified of. Any by the way the most recent tools are really, really good at PRs and commit messages.
Post reply on HN