The only thing stopping me from using Zig is the lack of docs

motiejus · on June 19, 2023

The language docs are OK: https://ziglang.org/documentation/master/

Zig taught me to read stdlib source, which I do at my $dayjob now too.

It is perfectly fine to read stdlib source. Start with lib/std/mem.zig after reading the docs about the language.

It is much more readable than the C "docs" ISO/IEC 9899:2011. I am so productive now. :)

lionkor · on June 20, 2023

C has cppreference, the standard is not made to be learned from.

Zigs stdlib have near zero usable docs.

Yes I know you can browse the code, but thats difficult since the zig lsp has very little idea about a lot of types.

eatonphil · on June 20, 2023

For me, I browse through the GitHub UI and I also keep local copies of Zig (for various releases) so I can `git grep` and glance through lib/std/mem.zig or lib/std/array_list.zig or (as in this post) lib/std/json/static.zig.

I'm not saying it works for everyone but frankly, like motiejus it sounds, I don't mind the minor challenge of being forced to read source code.

hiccuphippo · on June 19, 2023

Docs is something they'll probably tackle before version 1.0 after the language is stabilized and they clean up the standard library. Not much sense in writing docs if they are going to need rewriting soon.

Right now the best doc is to look at the tests in the code itself.