[{"data":1,"prerenderedAt":591},["ShallowReactive",2],{"project-38915999":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":34,"aspects":35,"strip":47,"post_text":49,"what":50,"said":79,"maker_in_thread":201,"shape":214,"grid":217,"attempts":554,"same_week":555,"maker_shows":40,"maker_hidden":583,"reader_version":584,"card":585},"38915999","Auto Wiki","Turn your codebase into a Wiki","title","Show HN: Auto Wiki – Turn your codebase into a Wiki","https:\u002F\u002Fwiki.mutable.ai","wiki.mutable.ai","oshams",1704738376,2024,183,132,439,3515,13,"notable","dev_tools","code documentation generator","web_app",[24,25,26,27],"code documentation","codebase wiki","auto documentation","code citations","mixed",-0.304,{"positive":31,"neutral":32,"mixed":33,"critical":32},10,29,0,68,{"docs":36,"execution":38,"idea":39,"pricing":42,"design":44,"privacy":46},{"positive":33,"critical":37},3,{"positive":37,"critical":18},{"positive":40,"critical":41},4,9,{"positive":33,"critical":43},1,{"positive":33,"critical":45},2,{"positive":33,"critical":43},[43,37,43,43,37,37,33,45,43,43,45,48,37,37,37,43,43,43,37,43,43,45,37,37,43,48,37,37,48,45,48,33,48,43,37,37,43,48,43,37],5,"Hi HN! I’m Omar from Mutable.ai. We want to introduce Auto Wiki (https:\u002F\u002Fwiki.mutable.ai\u002F), which lets you generate a Wiki-style website to document your codebase. Citations link to code, with clickable references to each line of code being discussed. Here are some examples of popular projects:\n\nReact: https:\u002F\u002Fwiki.mutable.ai\u002Ffacebook\u002Freact\n\nOllama https:\u002F\u002Fwiki.mutable.ai\u002Fjmorganca\u002Follama\n\nD3: https:\u002F\u002Fwiki.mutable.ai\u002Fd3\u002Fd3\n\nTerraform: https:\u002F\u002Fwiki.mutable.ai\u002Fhashicorp\u002Fterraform\n\nBitcoin: https:\u002F\u002Fwiki.mutable.ai\u002Fbitcoin\u002Fbitcoin\n\nMastodon: https:\u002F\u002Fwiki.mutable.ai\u002Fmastodon\u002Fmastodon\n\nAuto Wiki mak",{"problem":51,"audience":57,"pricing":66,"motivation":70,"time_to_build":74,"stack":75,"openness":76,"stage":77,"team_size":78},{"value":52,"source":53,"evidence":54},"Documenting a codebase is laborious and often neglected.","maker",[55],{"id":56},"post",{"value":58,"source":59,"evidence":60},"Developers and teams wanting documentation for their codebases.","inferred",[61,62],{"id":56},{"id":63,"by":64,"text":65},"38918220","TheEzEzz","Super cool. When I think about accelerating teams while maintaining quality\u002Fculture, I think about the adage \"if you want someone to do something, make it easy.\" Maintaining…",{"value":67,"source":53,"evidence":68},"Starts at $4 for private repo wikis, increasing by $2 increments with repo size.",[69],{"id":56},{"value":71,"source":53,"evidence":72},"Make it easy to see at a high level what a codebase does and how work is divided.",[73],{"id":56},null,[],"unknown","beta","company",{"praise":80,"objections":101,"requests":142,"questions":170,"alternatives":189},[81,90],{"value":82,"source":83,"evidence":84},"Good concept and useful for enterprise documentation.","commenter",[85,89],{"id":86,"by":87,"text":88},"38917298","faizshah","Can you talk a little bit about the crawler or what information are you feeding the agent about the repostory? My main concern is that this is just hallucinating the…",{"id":63,"by":64,"text":65},{"value":91,"source":83,"evidence":92},"Helpful for understanding large well-known projects.",[93,97],{"id":94,"by":95,"text":96},"38916887","huevosabio","Love the idea! I will try it on my own repo! As an aside, I've been thinking of creating an auto-wiki for game lore based on what AI npcs say, i.e. convert their hallucinations…",{"id":98,"by":99,"text":100},"38917116","vinibrito","Wow, looks nice! I almost felt like I could understand Bitcoins code xD Could you do Appwrite? https:\u002F\u002Fgithub.com\u002Fappwrite\u002Fappwrite I'm not affiliated to them, just wanted to get…",[102,117,128,135],{"value":103,"source":83,"evidence":104},"Generated documentation contains factual errors and hallucinations.",[105,109,113],{"id":106,"by":107,"text":108},"38917199","teraflop","Cool concept. Right off the bat I see some big issues with the generated CPython documentation: > This provides a register-based virtual machine that executes the bytecode…",{"id":110,"by":111,"text":112},"38918375","nerdponx","Great example of plausible but completely incorrect outputs from an AI model that would go largely undetected by a non-expert human.",{"id":114,"by":115,"text":116},"38917329","Amigo5862","The only thing I see that this adds over existing docs-to-HTML tooling is that it uses a wikipedia-inspired theme. Meanwhile on the negative side, it adds hallucinations. You say…",{"value":118,"source":83,"evidence":119},"Name 'wiki' is confusing since the output is not editable.",[120,124],{"id":121,"by":122,"text":123},"38917458","hk__2","That’s nice but the name is confusing: it’s not generating a wiki at all, but a documentation website with a Wikipedia-like theme. Wikis are collaborative websites; Wikipedia is…",{"id":125,"by":126,"text":127},"38917914","paxys","The entire point of a Wiki is that it can be collaboratively edited. This is static documentation, just with a Wikipedia-like UI.",{"value":129,"source":83,"evidence":130},"Maintainers could be burdened by misinformation from generated docs.",[131],{"id":132,"by":133,"text":134},"38920388","elicksaur","How are you going to handle this scenario: - Person reads your auto wiki explanation of some part of a codebase. - The explanation is incorrect. - The person, believing your…",{"value":136,"source":83,"evidence":137},"Request for write access to repos via GitHub raised privacy concerns.",[138],{"id":139,"by":140,"text":141},"38918362","sysread","Why does it request write access to my repos via gh auth?",[143,148,163],{"value":144,"source":83,"evidence":145},"Make wikis editable.",[146,147],{"id":125,"by":126,"text":127},{"id":132,"by":133,"text":134},{"value":149,"source":83,"evidence":150},"Generate wikis for specific repos.",[151,155,159],{"id":152,"by":153,"text":154},"38916984","pbowyer","Would be great to see for https:\u002F\u002Fgithub.com\u002Fsymfony\u002Fsymfony, thanks! As that's a monorepo it may provide a challenge to the tool.",{"id":156,"by":157,"text":158},"38917594","noone_youknow","Nice! I’d be interested to see how it handles https:\u002F\u002Fgithub.com\u002Frosco-m68k\u002Frosco_m68k , it’s a mixed software \u002F hardware repo, with a lot of code in assembler and C (for an old…",{"id":160,"by":161,"text":162},"38918445","solarkraft","I'd quite like some more high level documentation for the Matrix JS SDK (https:\u002F\u002Fgithub.com\u002Fmatrix-org\u002Fmatrix-js-sdk). I've been looking at it for quite some time and still don't…",{"value":164,"source":83,"evidence":165},"Better categorisation and working links.",[166],{"id":167,"by":168,"text":169},"38921493","Eiim","I'll go ahead and put in a request for my own repo: Eiim\u002FChokistream In the meantime, I have a different bit of feedback: the categories don't make much sense to me. I can't find…",[171,179],{"value":172,"source":83,"evidence":173},"How is hallucination prevented and what context is fed to the model?",[174,175],{"id":86,"by":87,"text":88},{"id":176,"by":177,"text":178},"38917401","GrinningFool","I would expect something like this to output only factually correct documentation since it would be used as reference; but it sounds like even under the upcoming v2 that's not…",{"value":180,"source":83,"evidence":181},"How does it handle smaller, less-documented projects?",[182,186],{"id":183,"by":184,"text":185},"38916785","CGamesPlay","I'd love to see the wiki generated for a less already-documented example. These high-profile projects are good demos and the results look compelling (I checked out AutoGPT's and…",{"id":187,"by":87,"text":188},"38917198","I would like to see how it performs on a lesser known project with less stars, these are all well known projects which would exist in the training data in blog posts etc.",[190,194],{"value":191,"source":83,"evidence":192},"Existing docs-to-HTML tooling.",[193],{"id":114,"by":115,"text":116},{"value":195,"source":83,"evidence":196},"Architecture Decision Records (ADRs).",[197],{"id":198,"by":199,"text":200},"38924270","8organicbits","I think this falls into a common mistake people make about documentation. Good documentation doesn't explain what the code does, it explains why the code is written the way it…",{"comments":202,"answered":203,"key":204},52,21,[205,208,211],{"id":206,"text":207},"38917233","Thank you for this feedback. We actually have an Auto Wiki v2 in the works which is even higher quality, would be interesting to see how it changes when that comes out.",{"id":209,"text":210},"38917704","It's purely based on the code and we force the LLM to cite the code it describes to cut back on hallucination. We are adding a self verification steps (like chain-of-verification…",{"id":212,"text":213},"38917712","We think chain-of-verification and fine tuning will help a lot see the other response. We are really excited to launch v2 ASAP so we can address these concerns.",{"commenters":215,"max_depth":48,"maker_replies":202,"first_comment_mins":32,"lifespan_hours":216},60,194,[218,220,222,224,225,227,231,235,238,239,240,241,244,247,249,252,255,259,263,265,268,270,273,276,279,280,283,284,286,288,291,294,298,301,304,307,308,311,314,317,319,322,324,326,329,331,334,337,339,342,346,348,350,352,354,358,360,362,365,369,373,375,378,380,382,384,386,389,393,395,397,399,402,404,406,408,410,413,415,417,420,424,426,428,430,432,434,436,438,440,444,446,448,450,452,457,461,465,468,470,472,474,476,478,480,484,486,488,490,494,498,500,502,504,507,509,511,513,515,517,520,524,526,529,533,535,539,543,546,550,552],[106,33,43,219,107,33],"project\u002Fcritical\u002Fdocs",[206,33,33,221,11,43],"maker\u002Fneutral\u002Fexecution",[86,33,37,223,87,33],"project\u002Fneutral\u002Fexecution",[209,33,33,223,11,43],[176,33,43,226,177,33],"project\u002Fcritical\u002Fexecution",[228,33,48,229,230,33],"38917509","project\u002Fpositive\u002Fidea","HL33tibCe7",[232,33,43,233,234,33],"38921751","project\u002Fcritical\u002Fpricing","krupan",[236,33,43,237,177,33],"38929347","project\u002Fcritical\u002Fidea",[212,33,33,223,11,43],[110,33,43,226,111,33],[121,43,43,237,122,33],[242,43,33,243,11,43],"38919753","project\u002Fneutral\u002Fidea",[245,43,43,237,246,33],"38919809","e12e",[248,43,33,243,11,43],"38919910",[250,43,33,251,122,33],"38938152","commenter\u002Fneutral\u002Fnone",[253,43,37,243,254,33],"38942187","jazzyjackson",[256,43,33,257,258,33],"38921804","other\u002Fneutral\u002Fnone","userbinator",[260,45,37,261,262,33],"38919432","project\u002Fneutral\u002Fdesign","velox_neb",[264,45,33,257,11,43],"38919635",[266,45,33,251,267,33],"38920058","wintogreen74",[269,45,33,251,133,33],"38920482",[271,45,33,251,272,33],"38921071","kuhewa",[274,45,37,261,275,33],"38921484","charcircuit",[277,45,37,261,278,33],"38921625","lucasban",[198,37,43,219,199,33],[281,37,33,251,282,33],"38925506","_a_a_a_",[125,40,43,237,126,33],[285,40,33,243,11,43],"38917918",[287,40,43,237,126,33],"38917959",[289,40,43,237,290,33],"38917979","hobo_mark",[292,40,43,219,293,33],"38918104","loktarogar",[295,40,33,296,297,33],"38925782","commenter\u002Fcritical\u002Fdocs","thfuran",[299,40,37,243,300,33],"38923526","bbor",[302,40,33,303,11,43],"38926189","maker\u002Fpositive\u002Fidea",[305,40,43,226,306,33],"38939553","dormento",[183,48,37,223,184,33],[309,48,33,310,11,43],"38916973","project\u002Fneutral\u002Fnone",[312,48,48,313,184,33],"38917428","project\u002Fpositive\u002Fexecution",[315,48,33,316,11,43],"38918740","project\u002Fneutral\u002Fprivacy",[63,318,48,229,64,33],6,[320,318,33,321,11,43],"38918389","maker\u002Fneutral\u002Fidea",[114,323,43,226,115,33],7,[152,325,37,310,153,33],8,[327,325,33,328,11,43],"38916992","maker\u002Fneutral\u002Fnone",[330,325,33,310,11,43],"39018272",[332,41,37,310,333,33],"38923859","erwan577",[335,31,37,223,336,33],"38916416","eduardosalaz",[338,31,33,223,11,43],"38916450",[340,341,33,316,11,43],"38921013",11,[343,344,43,226,345,33],"38916878",12,"comex",[347,344,33,310,11,43],"38916943",[349,344,37,261,345,33],"38917163",[139,18,43,351,140,33],"project\u002Fcritical\u002Fprivacy",[353,18,33,316,11,43],"38919714",[355,356,43,226,357,33],"38916703",14,"OmarShehata",[359,356,33,223,11,43],"38916753",[361,356,33,310,11,43],"38932259",[167,363,43,364,168,33],15,"project\u002Fcritical\u002Fdesign",[366,367,33,257,368,33],"38920891",16,"perpil",[370,371,37,310,372,33],"38920170",17,"chaorace",[374,371,33,328,11,43],"38920356",[376,371,37,377,372,33],"38927066","maker\u002Fneutral\u002Fdocs",[379,371,33,328,11,43],"38975835",[132,381,43,226,133,33],18,[383,381,33,223,11,43],"38920476",[385,381,43,237,133,33],"38920506",[387,381,33,251,388,33],"38923705","rajamaka",[390,391,37,310,392,33],"38917583",19,"TachyonicBytes",[394,391,43,226,392,33],"38917679",[396,391,33,328,11,43],"38920524",[398,391,37,310,392,33],"38923719",[400,391,37,310,401,33],"38924695","syrusakbary",[403,391,37,310,392,33],"38933229",[405,391,33,328,11,43],"38932280",[407,391,33,328,11,43],"38940172",[409,391,33,328,11,43],"38953812",[160,411,37,412,161,33],20,"project\u002Fneutral\u002Fdocs",[414,411,33,328,11,43],"38918543",[416,411,33,328,11,43],"38975829",[418,203,33,257,419,33],"38927307","danmur",[421,422,43,226,423,33],"38917619",22,"codetrotter",[425,422,33,221,11,43],"38917633",[427,422,33,251,423,33],"38917644",[94,429,48,229,95,33],23,[431,429,33,328,11,43],"38916988",[433,429,37,243,95,33],"38917661",[156,435,37,310,157,33],24,[437,435,33,328,11,43],"38919861",[439,435,33,328,11,43],"38975819",[441,442,37,310,443,33],"38916795",25,"localhost",[445,442,33,328,11,43],"38916894",[447,442,48,229,443,33],"38917060",[449,442,33,328,11,43],"38919844",[451,442,33,328,11,43],"38919692",[453,454,48,455,456,33],"38951221",26,"project\u002Fpositive\u002Fnone","ryan_platofy",[458,459,43,237,460,33],"38924382",27,"holoduke",[462,463,37,310,464,33],"38951627",28,"JadedBlueEyes",[466,32,43,364,467,33],"38918478","stevage",[469,32,33,328,11,43],"38918525",[471,32,33,328,11,43],"38975823",[98,473,48,455,99,33],30,[475,473,33,328,11,43],"38917197",[477,473,33,328,11,43],"38917202",[479,473,33,328,11,43],"38975824",[481,482,37,310,483,33],"38917153",31,"int_19h",[485,482,33,328,11,43],"38917402",[487,482,33,328,11,43],"38940230",[489,482,48,313,483,33],"38944940",[491,492,43,226,493,33],"38920832",32,"issung",[495,496,43,226,497,33],"38916560",33,"e28eta",[499,496,33,221,11,43],"38916568",[501,496,48,313,497,33],"38916814",[503,496,33,251,11,43],"38920007",[505,496,43,226,506,33],"38917416","janfoeh",[508,496,33,221,11,43],"38919839",[187,510,37,310,87,33],34,[512,510,33,328,11,43],"38917215",[514,510,43,226,87,33],"38917258",[516,510,33,221,11,43],"38917272",[518,519,33,221,11,43],"38917915",35,[521,522,37,310,523,33],"38923231",36,"raybb",[525,522,33,328,11,43],"38923323",[527,522,48,528,523,33],"38923383","maker\u002Fpositive\u002Fnone",[530,531,37,310,532,33],"38919793",37,"rcarmo",[534,531,33,328,11,43],"38919930",[536,537,43,237,538,33],"38924360",38,"RamblingCTO",[540,541,37,310,542,33],"38923467",39,"rsaarelm",[544,545,37,310,542,33],"38923833",40,[547,548,37,310,549,33],"38919612",41,"guites",[551,548,33,528,11,43],"38919679",[553,548,33,528,11,43],"38975804",[],[556,561,565,569,574,578],{"id":557,"name":558,"points":559,"category":560},"38901504","Nino",810,"productivity",{"id":562,"name":563,"points":564,"category":560},"38876707","time",758,{"id":566,"name":567,"points":568,"category":20},"38906989","HTMX Playground",482,{"id":570,"name":571,"points":572,"category":573},"38905590","scientific.place",165,"learning_science",{"id":575,"name":576,"points":577,"category":573},"38869672","sip-to-webrtc",154,{"id":579,"name":580,"points":581,"category":582},"38902042","Quickwit",145,"data",false,"v2",{"id":586,"name":5,"line":6,"ai":583,"cat":20,"year":13,"points":14,"comments":15,"rec":28,"s":587,"top":18,"kw":588,"maker":11,"domain":10,"tier":19,"attempts":33,"strip":589,"url":9,"mix":590,"praise":82,"objection":103,"sub":21},38915999,-0.3,[24,25,26,27],"1311330211253331113112331533525051331513",[31,32,33,32],1793991082518]