Live data from Hacker News

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

github.com

81–90 of 181 posts

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

#83
post #71

Earlier quoted context omitted.

mind explaining what exactly was insufferable here?

If you don't feel the same way from reading it, I'm not sure it can be explained.

I agree, it's hopelessly over-cheerful and tries to be cute. The pizza metaphor fell flat for me as well

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

#84
post #12

The overview diagrams it creates are pretty interesting, but the tone/style of the AI-generated text is insufferable to me - e.g. https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Req...

I guess you already know what a “Functional API” is and feel patronized. Also possibly you dislike the “cute analogy” factor.

I think this could be solved with an “assume the reader knows …” part of the prompt.

Definitely looks like ELI5 writing there, but many technical documents assume too much knowledge (especially implicit knowledge of the context) so even though I’m not a fan of this section either, I’m not so quick to dismiss it as having no value.

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

#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...

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

#87
post #9

I would find this more interesting if it made tutorials out if the Linux, LLVM, OpenZFS and FreeBSD codebases.

You would need a more specific goal than “make a tutorial”.

Do you have anything in mind? Are you familiar enough with any of those codebases to suggest something useful?

The task will be much more interesting if there is not a good existing tutorial that the LLM may have trained on.

OS kernel: tutorial on how to write a driver?

OpenZFS: ?

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

#88
post #84
post #12

The overview diagrams it creates are pretty interesting, but the tone/style of the AI-generated text is insufferable to me - e.g. https://the-pocket.github.io/Tutorial-Codebase-Knowledge/Req...

I guess you already know what a “Functional API” is and feel patronized. Also possibly you dislike the “cute analogy” factor. I think this could be solved with an “assume the reader knows …” part of the prompt. Definitely looks like ELI5 writing there, but many technical documents assume too much knowledge (especially implicit knowledge of the context) so even though I’m not a fan of this section either, I’m not so q…

I don't mind analogies if they actually convey some meaning, but this example just seems to be using it as an aesthetic flair.

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

#89
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...

This code creates an HTTP session, sets a cookie within that session, makes another request that automatically includes the cookie, and then prints the response showing the cookies that were sent.

I may miss the error, but could you elaborate where it is?

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

#90
post #89
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...

This code creates an HTTP session, sets a cookie within that session, makes another request that automatically includes the cookie, and then prints the response showing the cookies that were sent. I may miss the error, but could you elaborate where it is?

[deleted]
Post reply on HN