Auto Wiki
Dev tools
code documentation generator
SHOW HN2024
How HN took it
10 positive, 29 neutral or asking, 0 mixed, 29 critical, out of 68 comments about the project. Thread score -0.30.
Execution: 3 for, 13 againstIdea: 4 for, 9 againstDocs: 0 for, 3 againstDesign: 0 for, 2 againstPricing: 0 for, 1 against
The thread, comment by comment
Each row is a top-level comment and its replies, in HN's order. Select a cell to open that comment on HN.
positive neutral or mixed critical about another commenter or something else the maker
What HN said
What people liked
Good concept and useful for enterprise documentation.
From 2 comments
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…
faizshah on HNSuper cool. When I think about accelerating teams while maintaining quality/culture, I think about the adage "if you want someone to do something, make it easy." Maintaining…
TheEzEzz on HN
Helpful for understanding large well-known projects.
From 2 comments
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…
huevosabio on HNWow, looks nice! I almost felt like I could understand Bitcoins code xD Could you do Appwrite? https://github.com/appwrite/appwrite I'm not affiliated to them, just wanted to get…
vinibrito on HN
Objections
Generated documentation contains factual errors and hallucinations.
From 3 comments
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…
teraflop on HNGreat example of plausible but completely incorrect outputs from an AI model that would go largely undetected by a non-expert human.
nerdponx on HNThe 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…
Amigo5862 on HN
Name 'wiki' is confusing since the output is not editable.
From 2 comments
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…
hk__2 on HNThe entire point of a Wiki is that it can be collaboratively edited. This is static documentation, just with a Wikipedia-like UI.
paxys on HN
Maintainers could be burdened by misinformation from generated docs.
From 1 comment
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…
elicksaur on HN
Request for write access to repos via GitHub raised privacy concerns.
From 1 comment
Why does it request write access to my repos via gh auth?
sysread on HN
Requests
Make wikis editable.
From 2 comments
The entire point of a Wiki is that it can be collaboratively edited. This is static documentation, just with a Wikipedia-like UI.
paxys on HNHow 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…
elicksaur on HN
Generate wikis for specific repos.
From 3 comments
Would be great to see for https://github.com/symfony/symfony, thanks! As that's a monorepo it may provide a challenge to the tool.
pbowyer on HNNice! I’d be interested to see how it handles https://github.com/rosco-m68k/rosco_m68k , it’s a mixed software / hardware repo, with a lot of code in assembler and C (for an old…
noone_youknow on HNI'd quite like some more high level documentation for the Matrix JS SDK (https://github.com/matrix-org/matrix-js-sdk). I've been looking at it for quite some time and still don't…
solarkraft on HN
Better categorisation and working links.
From 1 comment
I'll go ahead and put in a request for my own repo: Eiim/Chokistream In the meantime, I have a different bit of feedback: the categories don't make much sense to me. I can't find…
Eiim on HN
Questions
How is hallucination prevented and what context is fed to the model?
From 2 comments
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…
faizshah on HNI 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…
GrinningFool on HN
How does it handle smaller, less-documented projects?
From 2 comments
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…
CGamesPlay on HNI 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.
faizshah on HN
Alternatives named
Existing docs-to-HTML tooling.
From 1 comment
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…
Amigo5862 on HN
Architecture Decision Records (ADRs).
From 1 comment
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…
8organicbits on HN