[{"data":1,"prerenderedAt":760},["ShallowReactive",2],{"project-43739456":3},{"id":4,"name":5,"line":6,"line_source":7,"title":8,"url":9,"domain":10,"maker":11,"posted_at":12,"year":13,"points":14,"comments":15,"rank_in_year":16,"shown_in_year":17,"top":18,"tier":19,"category":20,"subcategory":21,"format":22,"keywords":23,"reception":28,"sentiment":29,"stance_mix":30,"scored_comments":35,"aspects":36,"strip":50,"post_text":53,"what":54,"said":97,"maker_in_thread":203,"shape":215,"grid":219,"attempts":718,"same_week":723,"maker_shows":33,"maker_hidden":752,"reader_version":753,"card":754},"43739456","Tutorial-Codebase-Knowledge","An AI that turns GitHub codebases into easy tutorials","title","Show HN: I built an AI that turns GitHub codebases into easy tutorials","https:\u002F\u002Fgithub.com\u002FThe-Pocket\u002FTutorial-Codebase-Knowledge","github.com","zh2408",1745096681,2025,923,172,20,3837,1,"legend","dev_tools","documentation generator","cli",[24,25,26,27],"codebase documentation","code tutorial generator","gemini llm","onboarding docs","debated",0.121,{"positive":31,"neutral":32,"mixed":33,"critical":34},33,30,2,26,91,{"execution":37,"docs":40,"design":43,"pricing":44,"idea":46,"privacy":48,"performance":49},{"positive":38,"critical":39},7,8,{"positive":41,"critical":42},3,6,{"positive":41,"critical":41},{"positive":45,"critical":45},0,{"positive":47,"critical":38},9,{"positive":45,"critical":45},{"positive":45,"critical":33},[41,45,45,45,45,41,18,51,51,33,45,52,33,51,41,45,51,18,18,52,52,45,33,33,18,51,51,51,52,41,33,52,41,51,41,52,41,41,33,18],5,4,"https:\u002F\u002Fthe-pocket.github.io\u002FTutorial-Codebase-Knowledge\u002F",{"problem":55,"audience":67,"pricing":75,"motivation":75,"time_to_build":75,"stack":76,"openness":94,"stage":95,"team_size":96},{"value":56,"source":57,"evidence":58},"Codebases often lack good tutorials or documentation for newcomers","commenter",[59,63],{"id":60,"by":61,"text":62},"43741848","wg0","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.",{"id":64,"by":65,"text":66},"43745982","kaycebasques","Very cool, thanks for sharing. I imagine that this will make a lot of my fellow technical writers (even more) nervous about the future of our industry. I think the reality is…",{"value":68,"source":57,"evidence":69},"Developers learning or onboarding to unfamiliar codebases",[70,71],{"id":60,"by":61,"text":62},{"id":72,"by":73,"text":74},"43740879","TheTaytay","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…",null,[77,84],{"value":78,"source":57,"evidence":79},"Python",[80],{"id":81,"by":82,"text":83},"43744102","mooreds","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…",{"value":85,"source":86,"evidence":87},"Google Gemini 2.5 Pro","maker",[88,91],{"id":89,"by":11,"text":90},"43739791","No, I haven't, but I will check it out! One thing to note is that the tutorial generation depends largely on Gemini 2.5 Pro. Its code understanding ability is very good, combined…",{"id":92,"by":11,"text":93},"43740093","Yeah, I'd recommend trying Gemini 2.5 Pro. I know early Gemini weren't great, but the recent one is really impressive in terms of coding ability. This project is kind of designed…","open_source","prototype","unknown",{"praise":98,"objections":119,"requests":149,"questions":168,"alternatives":183},[99,111],{"value":100,"source":57,"evidence":101},"Useful for understanding unfamiliar codebases and onboarding",[102,103,107],{"id":60,"by":61,"text":62},{"id":104,"by":105,"text":106},"43741535","zarkenfrood","Really nice work and thank you for sharing. These are great demonstrations of the value of LLMs which help to go against the negative view on the impacts to junior engineers.…",{"id":108,"by":109,"text":110},"43742168","mvATM99","This is really cool and very practical. definitely will try it out for some projects soon. Can see some finetuning after generation being required, but assuming you know your own…",{"value":112,"source":57,"evidence":113},"Impressive output quality",[114,118],{"id":115,"by":116,"text":117},"43741857","gregpr07","I built browser use. Dayum, the results for our lib are really impressive, you didn’t touch outputs at all? One problem we have is maintaining the docs with current codebase…",{"id":81,"by":82,"text":83},[120,135,142],{"value":121,"source":57,"evidence":122},"Output tone is overly simplistic or overexcited",[123,127,131],{"id":124,"by":125,"text":126},"43741590","bilalq","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…",{"id":128,"by":129,"text":130},"43740362","Retr0id","The overview diagrams it creates are pretty interesting, but the tone\u002Fstyle of the AI-generated text is insufferable to me - e.g.…",{"id":132,"by":133,"text":134},"43745290","andybak","Is there a way to limit the number of exclamation marks in the output? It seems a trifle... overexcited at times.",{"value":136,"source":57,"evidence":137},"Generated docs don't replace human documentation",[138],{"id":139,"by":140,"text":141},"43748908","remoquete","This is nice and fun for getting some fast indications on an unknown codebase, but, as others said here and elsewhere, it doesn't replace human-made documentation.…",{"value":143,"source":57,"evidence":144},"Possible factual errors in generated code examples",[145],{"id":146,"by":147,"text":148},"43743958","istjohn","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:…",[150,157],{"value":151,"source":57,"evidence":152},"Adjustable tone or style template",[153],{"id":154,"by":155,"text":156},"43740594","manofmanysmiles","I love it! I effectively achieve similar results by asking Cursor lots of questions! Like at least one other person in the comments mentioned, I would like a slightly different…",{"value":158,"source":57,"evidence":159},"Support for larger codebases beyond context limits",[160,164],{"id":161,"by":162,"text":163},"43740101","ryao","I would find this more interesting if it made tutorials out if the Linux, LLVM, OpenZFS and FreeBSD codebases.",{"id":165,"by":166,"text":167},"43767715","nitinram","This is super cool! I attempted to use this on a project and kept running into \"This model's maximum context length is 200000 tokens. However, your messages resulted in 459974…",[169,176],{"value":170,"source":57,"evidence":171},"How much does it cost to run",[172],{"id":173,"by":174,"text":175},"43742418","potamic","Did you measure how much it cost to run it against your examples? Trying to gauge how much it would cost to run this against my repos.",{"value":177,"source":57,"evidence":178},"Can it use private repositories",[179],{"id":180,"by":181,"text":182},"43744956","polishdude20","Is there an easy way to have this visit a private repository? I've got a new codebase to learn and it's behind credentials.",[184,189,196],{"value":185,"source":57,"evidence":186},"Cursor or Claude Code prompting for docs",[187,188],{"id":154,"by":155,"text":156},{"id":72,"by":73,"text":74},{"value":190,"source":57,"evidence":191},"Mutable AI",[192],{"id":193,"by":194,"text":195},"43740385","chairhairair","A company (mutable ai) was acquired by Google last year for essentially doing this but outputting a wiki instead of a tutorial.",{"value":197,"source":57,"evidence":198},"gitdiagram",[199],{"id":200,"by":201,"text":202},"43746740","bdg001","I was using gitdiagram but llms are very bad at generating good error free mermaid code! Thanks buddy! this will be very helpful !!",{"comments":204,"answered":39,"key":205},13,[206,209,212],{"id":207,"text":208},"43740621","Thanks—would really appreciate your PR!",{"id":210,"text":211},"43740451","Their site seems to be down. I can't find their results.",{"id":213,"text":214},"43743409","Thank you! And correct, I didn't modify the outputs. For small changes, you can just feed the commit history and ask an LLM to modify the docs. If there are lots of…",{"commenters":216,"max_depth":47,"maker_replies":204,"first_comment_mins":217,"lifespan_hours":218},116,25,261,[220,222,226,230,233,235,239,242,245,248,250,253,256,258,260,264,266,269,272,275,278,281,284,287,291,294,296,298,301,304,308,312,314,316,319,320,322,324,327,330,333,336,339,340,341,344,347,349,352,354,355,358,359,362,364,366,368,372,377,379,382,387,391,394,397,400,404,407,409,412,416,418,422,424,426,429,432,434,438,442,444,446,448,452,453,456,460,464,466,471,474,477,479,481,482,484,488,491,494,496,499,502,505,508,512,516,519,521,525,527,530,533,535,538,541,544,546,548,550,552,556,560,564,568,572,574,576,579,583,587,591,595,597,601,603,607,612,616,620,624,628,632,635,638,640,643,645,647,649,653,657,660,664,668,672,674,677,680,682,684,687,690,693,695,697,699,701,703,706,710,712,715],[124,45,41,221,125,45],"project\u002Fmixed\u002Fexecution",[223,45,45,224,225,45],"43741600","commenter\u002Fneutral\u002Fnone","hackernewds",[227,45,45,228,229,45],"43742140","commenter\u002Fneutral\u002Fdocs","trcf21",[231,45,45,224,232,45],"43742316","porridgeraisin",[234,45,45,224,229,45],"43742558",[236,45,45,237,238,45],"43743287","other\u002Fneutral\u002Fnone","cushychicken",[240,45,45,237,241,45],"43747735","linotype",[243,45,45,237,244,45],"43748069","grugagag",[246,45,45,237,247,45],"43749673","microtonal",[249,45,45,237,65,45],"43750777",[251,45,45,237,252,45],"43750978","iteria",[254,45,45,237,255,45],"43751189","simonw",[257,45,45,237,244,45],"43758030",[259,45,45,237,255,45],"43758493",[261,45,45,262,263,45],"43760270","other\u002Fneutral\u002Fperformance","LunaSea",[265,45,45,237,255,45],"43762374",[267,45,45,237,268,45],"43747998","CodeMage",[270,45,45,237,271,45],"43748898","doug_durham",[273,45,45,237,274,45],"43752450","svieira",[276,45,45,237,277,45],"43748404","panny",[279,45,45,237,280,45],"43748953","tossandthrow",[282,45,45,237,283,45],"43749109","jonahx",[285,45,41,286,65,45],"43750699","project\u002Fneutral\u002Fnone",[288,45,45,289,290,45],"43752182","other\u002Fneutral\u002Fpricing","voidUpdate",[292,45,45,289,293,45],"43752251","GaggiX",[295,45,45,237,290,45],"43752276",[297,45,45,237,293,45],"43752305",[299,45,45,237,300,45],"43769011","otabdeveloper4",[302,45,18,303,65,45],"43746793","project\u002Fcritical\u002Fdocs",[305,45,18,306,307,45],"43764213","project\u002Fcritical\u002Fexecution","neop1x",[309,18,51,310,311,45],"43750622","project\u002Fpositive\u002Fdesign","swashbuck1r",[81,33,51,313,82,45],"project\u002Fpositive\u002Fexecution",[315,33,51,313,82,45],"43744625",[317,33,41,318,82,45],"43747797","project\u002Fneutral\u002Fpricing",[154,41,51,310,155,45],[207,41,45,321,11,18],"maker\u002Fpositive\u002Fnone",[72,52,51,323,73,45],"project\u002Fpositive\u002Fidea",[325,52,51,313,326,45],"43748435","randomcatuser",[328,51,41,286,329,45],"43744642","fforflo",[331,51,41,332,82,45],"43744660","project\u002Fneutral\u002Fprivacy",[334,51,41,335,329,45],"43744828","project\u002Fneutral\u002Fperformance",[337,42,18,306,338,45],"43748738","Too",[193,38,45,237,194,45],[210,38,45,237,11,18],[342,38,45,237,343,45],"43740522","codetrotter",[345,38,45,237,346,45],"43742710","nxobject",[348,38,45,237,194,45],"43743638",[350,38,45,224,351,45],"43745725","cowsandmilk",[353,38,18,306,65,45],"43750652",[115,39,51,313,116,45],[356,39,51,323,357,45],"43741915","cehrlich",[213,39,45,321,11,18],[360,47,18,306,361,45],"43741265","esjeon",[139,363,18,303,140,45],10,[365,363,51,323,65,45],"43750928",[367,363,45,237,140,45],"43751174",[369,370,45,237,371,45],"43848818",11,"axelr340",[373,374,51,375,376,45],"43745956",12,"maker\u002Fpositive\u002Fexecution","mattfrommars",[378,204,51,313,329,45],"43744835",[380,204,41,286,381,45],"43749840","3abiton",[383,384,45,385,386,45],"43743668",14,"other\u002Fneutral\u002Fidea","amelius",[388,384,45,389,390,45],"43744382","other\u002Fneutral\u002Fdocs","tdy_err",[392,384,51,393,238,45],"43744398","project\u002Fpositive\u002Fdocs",[395,384,18,303,396,45],"43744780","runeks",[398,384,45,224,399,45],"43745102","johnnyyyy",[401,384,45,402,403,45],"43745807","commenter\u002Fcritical\u002Fdocs","oblio",[405,384,45,228,406,45],"43748933","bonzini",[408,384,45,402,140,45],"43751203",[108,410,51,411,109,45],15,"project\u002Fpositive\u002Fnone",[413,414,51,323,415,45],"43748413",16,"citizenpaul",[60,417,51,323,61,45],17,[419,417,18,420,421,45],"43742364","project\u002Fcritical\u002Fidea","tgv",[423,417,45,224,61,45],"43744651",[128,425,18,303,129,45],18,[427,425,45,428,11,18],"43740382","maker\u002Fneutral\u002Fdocs",[430,425,45,224,431,45],"43741323","vivzkestrel",[433,425,45,224,129,45],"43743041",[435,425,18,436,437,45],"43743853","project\u002Fcritical\u002Fdesign","stevedonovan",[439,425,41,440,441,45],"43743905","project\u002Fneutral\u002Fdocs","fn-mote",[443,425,18,436,129,45],"43744007",[64,445,45,237,65,45],19,[447,445,45,237,65,45],"43759012",[449,445,45,450,451,45],"43821077","other\u002Fpositive\u002Fnone","teknico",[173,16,41,318,174,45],[454,16,41,318,455,45],"43743165","pitched",[457,458,51,393,459,45],"43742028",21,"stephantul",[461,462,51,393,463,45],"43744653",22,"theptip",[465,462,41,440,82,45],"43744742",[467,468,41,469,470,45],"43739621",23,"project\u002Fneutral\u002Fidea","badmonster",[472,468,45,473,11,18],"43739684","maker\u002Fneutral\u002Fidea",[475,468,45,237,476,45],"43739717","kristopolous",[89,468,45,478,11,18],"maker\u002Fneutral\u002Fnone",[480,468,45,224,476,45],"43739846",[92,468,45,478,11,18],[483,468,45,224,476,45],"43740860",[485,486,18,303,487,45],"43790528",24,"iamsaitam",[489,217,41,469,490,45],"43754198","1899-12-30",[492,34,41,440,493,45],"43742153","ganessh",[495,34,45,478,11,18],"43743456",[497,34,41,286,498,45],"43744063","m0rde",[500,34,41,286,501,45],"43744412","Tokumei-no-hito",[165,503,18,504,166,45],27,"project\u002Fcritical\u002Fperformance",[506,503,45,507,11,18],"43767986","maker\u002Fneutral\u002Fperformance",[509,510,45,385,511,45],"43757814",28,"lummm",[513,514,18,420,515,45],"43745090",29,"bionhoward",[517,32,41,469,518,45],"43742355","pknerd",[520,32,45,428,11,18],"43743482",[522,523,51,323,524,45],"43741447",31,"chbkall",[104,526,51,323,105,45],32,[528,31,51,323,529,45],"43741499","android521",[531,31,45,224,532,45],"43741563","croes",[534,31,51,321,225,45],"43741603",[536,31,45,537,532,45],"43741680","other\u002Fcritical\u002Fnone",[539,31,45,224,540,45],"43741774","relativ575",[542,31,45,224,543,45],"43741801","murkt",[545,31,45,237,532,45],"43742069",[547,31,45,237,532,45],"43742042",[549,31,45,224,540,45],"43741766",[551,31,45,224,532,45],"43742266",[553,554,51,411,555,45],"43749870",34,"lastdong",[557,558,41,469,559,45],"43744619",35,"touristtam",[561,562,18,420,563,45],"43744103",36,"thom",[565,566,51,411,567,45],"43743754",37,"trash_cat",[569,570,51,310,571,45],"43744658",38,"orsenthil",[180,573,41,286,181,45],39,[575,573,45,478,11,18],"43744978",[577,573,41,578,166,45],"43767695","project\u002Fneutral\u002Fexecution",[580,581,51,411,582,45],"43741598",40,"andrewrn",[584,585,18,303,586,45],"43747680",41,"gbraad",[588,589,18,420,590,45],"43740961",42,"throwaway314155",[592,589,45,593,594,45],"43741185","commenter\u002Fneutral\u002Fidea","j45",[200,596,51,411,201,45],43,[598,599,18,306,600,45],"43744409",44,"dangoodmanUT",[132,602,18,436,133,45],45,[604,605,51,411,606,45],"43744768",46,"las_nish",[608,609,41,610,611,45],"43761619",47,"maker\u002Fneutral\u002Fexecution","rtcoms",[613,614,51,411,615,45],"43742917",48,"anshulbhide",[617,618,51,411,619,45],"43743942",49,"souhail_dev",[621,622,41,286,623,45],"43745130",50,"lasarkolja",[625,626,41,286,627,45],"43740946",51,"CalChris",[629,630,18,420,631,45],"43742526",52,"throwaway290",[633,630,45,224,634,45],"43742593","afro88",[636,630,41,637,631,45],"43742633","project\u002Fmixed\u002Fperformance",[639,630,45,224,634,45],"43742958",[641,630,45,228,642,45],"43742655","quantumHazer",[644,630,51,323,634,45],"43742949",[646,630,45,228,642,45],"43747215",[648,630,51,313,634,45],"43760562",[650,651,41,286,652,45],"43743300",53,"firesteelrain",[654,655,18,420,656,45],"43742835",54,"saberience",[658,655,18,420,659,45],"43743398","eapriv",[661,662,51,411,663,45],"43741930",55,"mraza007",[665,666,51,411,667,45],"43743727",56,"chyueli",[669,670,45,237,671,45],"43741172",57,"lionturtle",[161,673,41,286,162,45],58,[675,673,45,224,676,45],"43740141","wordofx",[678,673,45,224,679,45],"43742208","revskill",[681,673,45,224,162,45],"43745087",[683,673,45,335,11,18],"43740152",[685,673,41,578,686,45],"43740668","rtolsma",[688,673,41,286,689,45],"43741788","achierius",[691,673,41,286,692,45],"43743038","throwup238",[694,673,41,286,162,45],"43745188",[696,673,41,469,441,45],"43743972",[698,673,41,469,162,45],"43745164",[146,700,18,306,147,45],59,[702,700,45,610,11,18],"43744024",[704,700,18,306,705,45],"43744085","Armazon",[707,700,45,708,709,45],"43744096","commenter\u002Fneutral\u002Fexecution","foobarbecue",[711,700,45,708,705,45],"43744145",[713,700,18,306,714,45],"43744100","totally",[716,700,18,504,717,45],"43748861","ForOldHack",[719,722],{"id":720,"t":721,"points":41,"comments":45},"43601999",1743952397,{"id":4,"t":12,"points":14,"comments":15},[724,729,734,739,743,748],{"id":725,"name":726,"points":727,"category":728},"43754124","Dia",652,"ai",{"id":730,"name":731,"points":732,"category":733},"43729683","The Backdooms",531,"games",{"id":735,"name":736,"points":737,"category":738},"43734910","Undercutf1",301,"consumer_social",{"id":740,"name":741,"points":742,"category":738},"43745554","JuryNow",263,{"id":744,"name":745,"points":746,"category":747},"43771365","Scrimba",258,"learning_science",{"id":749,"name":750,"points":751,"category":747},"43734583","Gridbach",244,false,"v2",{"id":755,"name":5,"line":6,"ai":752,"cat":20,"year":13,"points":14,"comments":15,"rec":28,"s":756,"top":18,"kw":757,"maker":11,"domain":10,"tier":19,"attempts":33,"strip":758,"url":9,"mix":759,"praise":100,"objection":121,"sub":21},43739456,0.12,[24,25,26,27],"3000031552042530511440221555432435343321",[31,32,33,34],1794036673166]