Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

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

github.com

Post reply on HN
Print view View original

101–110 of 181 posts

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

#101

Post by Tokumei-no-hito »

zh2408 wrote: post #77
ganessh wrote: post #51

Does it use the docs in the repository or only the code?

By default we use both based on regex: DEFAULT_INCLUDE_PATTERNS = { " .py", " .js", " .jsx", " .ts", " .tsx", " .go", " .java", " .pyi", " .pyx", " .c", " .cc", " .cpp", " .h", " .md", " .rst", "Dockerfile", "Makefile", " .yaml", " .yml", } DEFAULT_EXCLUDE_PATTERNS = { " test ", "tests/ ", "docs/ ", "examples/ ", "v1/ ", "dist/ ", "build/ ", "experimental/ ", "deprecated/ ", "legacy/ ", ".git/ ", ".github/ ", ".next/…

why exclude tests and docs by default?

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

#103

Post by mooreds »

mooreds wrote: 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: added note that there are examples in the original link.

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

#104

Post by fforflo »

If you want to use Ollama to run local models, here’s a simple example:

from ollama import chat, ChatResponse

def call_llm(prompt, use_cache: bool = True, model="phi4") -> str: response: ChatResponse = chat( model=model, messages=[{ 'role': 'user', 'content': prompt, }] ) return response.message.content

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

#105

Post by wg0 »

tgv wrote: post #57
wg0 wrote: post #43

That's a game changer for a new Open source contributor's onboarding. Put in postgres or redis codebase, get a good understanding and get going to contribute.

Isn't that overly optimistic? The postgres source code is really complex, and reading a dummy tutorial isn't going to make you a database engine ninja. If a simple tutorial can, imagine what a book on the topic could do.

No, I am not that optimistic about LLMs. I just think that something is better then nothing.

The burden of understanding still is with the engineers. All you would get is some (partially inaccurate at places) good overview of where to look for.

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

#106

Post by theptip »

Yes! AI for docs is one of the usecases I’m bullish on. There is a nice feedback loop where these docs will help LLMs to understand your code too. You can write a GH action to check if your code change / release changes the docs, so they stay fresh. And run your tutorials to ensure that they remain correct.

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

#108

Post by mooreds »

fforflo wrote: post #104

If you want to use Ollama to run local models, here’s a simple example: from ollama import chat, ChatResponse def call_llm(prompt, use_cache: bool = True, model="phi4") -> str: response: ChatResponse = chat( model=model, messages=[{ 'role': 'user', 'content': prompt, }] ) return response.message.content

Is the output as good?

I'd love the ability to run the LLM locally, as that would make it easier to run on non public code.

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

#109

Post by mooreds »

theptip wrote: post #106

Yes! AI for docs is one of the usecases I’m bullish on. There is a nice feedback loop where these docs will help LLMs to understand your code too. You can write a GH action to check if your code change / release changes the docs, so they stay fresh. And run your tutorials to ensure that they remain correct.

> And run your tutorials to ensure that they remain correct.

Do you have examples of LLMs running tutorials you can share?

Post reply on HN