3 ms·
Very cool velut! I'm super excited to see this type of documentation roll out to more languages, I quite firmly believe this is a great boon to developer produc
by slimsag 5y ago
Very cool velut! I'm super excited to see this type of documentation roll out to more languages, I quite firmly believe this is a great boon to developer productivity in general. I'm glad to see I am not the only one :)
I actually believe in this so much that I have been working on a language-agnostic version of this in my spare time on the side as a fun hack-project, and also recently convinced others at my work (Sourcegraph) of how good an idea this is: over there we're building this on top of LSIF (https://lsif.dev https://lsif.dev) by having language indexers emit documentation in a structured form that makes sense for the given language (so the structure of documentation is determined by the language indexer, and the "browser" / "layout" for it could be a website like this, your editor, generating a static Markdown file, etc.)
For example, some really quick/hacky Markdown I generated just now from LSIF data for the Go HTTP packages here: https://gist.github.com/slimsag/069d8498890ea6a3ec85dee3ef6f18c8#net-http https://gist.github.com/slimsag/069d8498890ea6a3ec85dee3ef6f...
Not trying to advertise anything here, just trying to say THIS IS SO COOL! I hope we get this for more languages!
Some others I know of:
* Go: https://pkg.go.dev https://pkg.go.dev and https://godocs.io https://godocs.io ("the good one")
* Rust: https://docs.rs https://docs.rs
* Java: https://javadoc.io https://javadoc.io
* Zig: https://ziglang.org/documentation/master/std/#builtin https://ziglang.org/documentation/master/std/#builtin
I'd be keen to hear if anybody knows of ones I don't!
- velut 5y agoThank you for your kind words! Your LSIF approach sounds interesting, I'll look into it. Another documentation host I know of is https://hexdocs.pm/ https://hexdocs.pm/ for Elixir packages.