Show HN: Auto Wiki – Turn your codebase into a Wiki • Hacker News Board

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#111

Post by thfuran » Tue, Jan 09, 2024, 1:13 PM UTC

loktarogar wrote: post #54

oshams wrote: post #51

Earlier quoted context omitted.

Would this be your top request? We're thinking of adding that functionality.

Regardless if it's a wiki or not right now, documentation that is wrong and cannot be fixed is worthless

No, it has negative value. Worthlessness world be an improvement.

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#112

Post by oshams » Tue, Jan 09, 2024, 1:55 PM UTC

bbor wrote: post #101

oshams wrote: post #51

Earlier quoted context omitted.

Would this be your top request? We're thinking of adding that functionality.

Consider leaning into “wiki” features fully so you don’t have to lose your name, and adding an edit button isn’t gonna be enough for most people IMO. As you can probably tell from these unusually hostile comments for HN (I think someone above even swore !), people are understandably protective of the wiki movement. It’s a bright, persistent star in a darkening internet, so seeing people use it to make money can be to…

This is a really interesting idea, thanks.

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#113

Post by chaorace » Tue, Jan 09, 2024, 3:13 PM UTC

oshams wrote: post #81

chaorace wrote: post #80

Let's see how it fares against a Nix flake: https://github.com/hyprland-community/hyprland-nix

We like it when users bring us their toughest challenges!

XD I figured that this one might be a tough nut to crack! I'm very interested to see how well it handles extracting in-code documentation when the embedded README is so sparse. I suspect that the resulting quality is going to hinge rather heavily upon the network's pre-existing "knowledge" of outside codebases (hyprland, in this case)

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#114

Post by danmur » Tue, Jan 09, 2024, 3:34 PM UTC

Love how github is basically a synonym for git now. I'm sure it's fine, homogeneity works so well everywhere else. Robust.

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#115

Post by GrinningFool » Tue, Jan 09, 2024, 5:54 PM UTC

HL33tibCe7 wrote: post #39

GrinningFool wrote: post #34

Earlier quoted context omitted.

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 the case?

Autogenerating documentation that could then be corrected by a human could still have value, in fairness

For one-and-done, I agree. But if you're looking at dynamic code base and you want to keep your documentation in sync, having to make 'manually correct the generated output' part of your build process can get expensive. (And tedious for the poor grunt who's got to do the work.)

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#116

Post by oshams » Tue, Jan 09, 2024, 9:20 PM UTC

OmarShehata wrote: post #7

The Bitcoin and Mastadon links don't seem to be working! (wiki not found) Would love to see this for Godot ( https://github.com/godotengine/godot ). Maybe Maplibre too ( https://github.com/maplibre/maplibre-native )!

Hey: https://wiki.mutable.ai/maplibre/maplibre-native is ready

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#117

Post by oshams » Tue, Jan 09, 2024, 9:22 PM UTC

TachyonicBytes wrote: post #40

As long as this is happening, might as well try some of my favorites: https://github.com/wasm3/wasm3 , https://github.com/WebAssembly/wabt , https://github.com/bytecodealliance/wasmtime

https://wiki.mutable.ai/bytecodealliance/wasmtime is ready

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#118

Post by TachyonicBytes » Tue, Jan 09, 2024, 10:33 PM UTC

syrusakbary wrote: post #109

oshams wrote: post #86

Earlier quoted context omitted.

So sorry, missed this, we're on it! Great choices btw. Wasm related stuff is a good test for auto wiki.

Just suggested as well Wasmer on Twitter! https://github.com/wasmerio/wasmer Looking forward to seeing the results :)

Yes, would love to see a wasm runtime comparison

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#119

Post by hk__2 » Wed, Jan 10, 2024, 9:28 AM UTC

oshams wrote: post #76

e12e wrote: post #72

Earlier quoted context omitted.

A wiki is a wiki wiki (quick, fast) web. It's defining characteristic is quickly and easily user-editable. Your current product isn't a wiki generator, it's a website generator. https://en.m.wikipedia.org/wiki/Wiki

Great point! It's a website generator in the style of wikis that could become a wiki in the future if we add the ability to edit it.

It’s not "in the style of wikis". The only thing that makes a website a wiki is that it’s editable. It’s like saying "we made a website in the style of Facebook" because you put blue everywhere. (I’m not trying to be snarky, just to give you an analogy)

Re: Show HN: Auto Wiki – Turn your codebase into a Wiki

#120

Post by dormento » Wed, Jan 10, 2024, 2:56 PM UTC

paxys wrote: post #49

The entire point of a Wiki is that it can be collaboratively edited. This is static documentation, just with a Wikipedia-like UI.

And its wrong! Its not difficult to find whole paragraphs that were entirely made up. LLMs are not fit for this sort of thing.