3 ms·

Zig documentation isn't crap; the documentation does not exist yet. There's an important difference between the two which seems to be ignored. Zig is young.

by bollu 5y ago

Zig documentation isn't crap; the documentation *does not exist* yet. There's an important difference between the two which seems to be ignored. Zig is young. They're spending their time maturing the core ecosystem --- the compiler, the standard library, and so forth. It's perfectly reasonable to expect early adopters to "RTFS/read the fucking source". *When* they start writing documentation, I'd be perfectly happy to hear comments like "The zig documentation is crap". At this stage of the project, I'll be honest, I find it upsetting to read comments like this.

rootlocus 5y ago
Zig absolutely has documentation: https://ziglang.org/documentation/master/ https://ziglang.org/documentation/master/
- delphLonepaw 5y ago
  That's the language reference, that also links the experimental autogenerated std documentation Right now, Zig is young and the documentation is kinda ok (Language reference is clear enough, outside a few things that need better visibility, for example, explaining concepts that are only on the examples can be lost easy), the autogenerated std on the other hand used to work meh, until a commit broke it afaik, so rn is in a pityfull state, but there is no use in reworking it until stage 2, so that's that
  - rootlocus 5y ago
    Well, the STD documentation page has a red banner saying it's experimental and you should consider reading the code (which worked great for me) so at least you have a warning.
coldtea 5y ago
>Zig documentation isn't crap; the documentation does not exist* yet. There's an important difference between the two which seems to be ignored.* Well, crap as an offering (what you get atm), not necessarily as in the quality of what little it is. It does though have a reference and documentation page: https://ziglang.org/learn/ https://ziglang.org/learn/
- kristoff_it 5y ago
  The autogenerated docs immediately greet you with a red banner that states These docs are experimental. Progress depends on the self-hosted compiler, consider reading the stdlib source in the meantime. It also links to a page that explains how the standard library is structured: https://github.com/ziglang/zig/wiki/How-to-read-the-standard-library-source-code https://github.com/ziglang/zig/wiki/How-to-read-the-standard...

Zig documentation isn't crap; the documentation *does not exist* yet. There's an important difference between the two which seems to be ignored. Zig is young.

by bollu 5y ago

rootlocus 5y ago

Zig absolutely has documentation: https://ziglang.org/documentation/master/ https://ziglang.org/documentation/master/

delphLonepaw 5y ago
That's the language reference, that also links the experimental autogenerated std documentation Right now, Zig is young and the documentation is kinda ok (Language reference is clear enough, outside a few things that need better visibility, for example, explaining concepts that are only on the examples can be lost easy), the autogenerated std on the other hand used to work meh, until a commit broke it afaik, so rn is in a pityfull state, but there is no use in reworking it until stage 2, so that's that
- rootlocus 5y ago
  Well, the STD documentation page has a red banner saying it's experimental and you should consider reading the code (which worked great for me) so at least you have a warning.

coldtea 5y ago

>Zig documentation isn't crap; the documentation does not exist* yet. There's an important difference between the two which seems to be ignored.* Well, crap as an offering (what you get atm), not necessarily as in the quality of what little it is. It does though have a reference and documentation page: https://ziglang.org/learn/ https://ziglang.org/learn/

kristoff_it 5y ago
The autogenerated docs immediately greet you with a red banner that states These docs are experimental. Progress depends on the self-hosted compiler, consider reading the stdlib source in the meantime. It also links to a page that explains how the standard library is structured: https://github.com/ziglang/zig/wiki/How-to-read-the-standard-library-source-code https://github.com/ziglang/zig/wiki/How-to-read-the-standard...