Live data from Hacker News

AI documentation you can talk to, for every repo

deepwiki.com

21–30 of 132 posts

Re: AI documentation you can talk to, for every repo

#22
post #16

I took a look at a project I maintain[0], and wow. It's so wrong in every section I saw. The generated diagrams make no sense. The text sections take implementation details that don't matter and present them to the user like they need to know them. It's also outdated. I hope actual users never see this. I dread thinking about having to go around to various LLM generated sites to correct documentation I never approved…

> The text sections take implementation details that don't matter and present them to the user like they need to know them. It's also outdated.

The point of the wiki is to help people learn the codebase so they can possibly contribute to the project, not for end users. It absolutely should explain implementation details. I do agree that it goes overboard with the diagrams. I’m curious, I’ve seen other moderately sized repo owners rave about how DeepWiki did very well in explaining implementation details. What specifically was it getting wrong about your code in your case? Is it just that it’s outdated?

Re: AI documentation you can talk to, for every repo

#24
post #16

I took a look at a project I maintain[0], and wow. It's so wrong in every section I saw. The generated diagrams make no sense. The text sections take implementation details that don't matter and present them to the user like they need to know them. It's also outdated. I hope actual users never see this. I dread thinking about having to go around to various LLM generated sites to correct documentation I never approved…

I fear the consequences will be even darker: - Users are confused by autogenerated docs and don’t even want to try using a project because of it - Real curated project documentation is no longer corrected by users feedback (because they never reach it) - LLMs are trained on wrong autogenerated documentation: a downward spiral for hallucinations! (Maybe this one could then force users go look for the official docs? Bu…

> LLMs are trained on wrong autogenerated documentation: a downward spiral for hallucinations! (Maybe this one could then force users go look for the official docs? But not sure at this point…)

On this, I think, we should have some kind of AI-generated meta-tag, like this: https://github.com/whatwg/html/issues/9479

Re: AI documentation you can talk to, for every repo

#25
post #16

I took a look at a project I maintain[0], and wow. It's so wrong in every section I saw. The generated diagrams make no sense. The text sections take implementation details that don't matter and present them to the user like they need to know them. It's also outdated. I hope actual users never see this. I dread thinking about having to go around to various LLM generated sites to correct documentation I never approved…

> The text sections take implementation details that don't matter and present them to the user like they need to know them. It's also outdated. The point of the wiki is to help people learn the codebase so they can possibly contribute to the project, not for end users. It absolutely should explain implementation details. I do agree that it goes overboard with the diagrams. I’m curious, I’ve seen other moderately size…

I dunno, it seems to be real excited about a VS Code extension that doesn't exist and isn't mentioned in the actual documentation. There's just too many factual errors to list.

Re: AI documentation you can talk to, for every repo

#28
post #25

Earlier quoted context omitted.

> The text sections take implementation details that don't matter and present them to the user like they need to know them. It's also outdated. The point of the wiki is to help people learn the codebase so they can possibly contribute to the project, not for end users. It absolutely should explain implementation details. I do agree that it goes overboard with the diagrams. I’m curious, I’ve seen other moderately size…

I dunno, it seems to be real excited about a VS Code extension that doesn't exist and isn't mentioned in the actual documentation. There's just too many factual errors to list.

>I dunno, it seems to be real excited about a VS Code extension that doesn't exist and isn't mentioned in the actual documentation. There's just too many factual errors to list.

There is a folder for a VS Code extension here[0]. It seems to have a README with installation instructions. There is also an extension.ts file, which seems to me to be at least the initial prototype for the extension. Did you forget that you started implementing this?

[0] https://github.com/blopker/codebook/blob/c141f349a10ba170424...

Post reply on HN