Comment by flohofwoe

Comment by flohofwoe 2 days ago

1 reply

> already has an engine for building websites with Zig, but making sure that every Zig library has docs

Tbh, this sort of auto-generated docs from source code is not all that useful, since you get that same information right in the IDE via the language server.

The important documentation part that's currently missing is how everything is supposed to work together in the stdlib, not the 'micro-documentation' of what a single type or function does. And for this sort of information it's currently indeed better to look at example code (e.g. the stdlib's testing code).

IMHO it's way too early for this type of high-level documentation, since things change all the time in the stdlib. Putting much work into documenting concepts that are discarded again anyway doesn't make much sense.

BobbyJo a day ago

Tests very often don't tell you the right way to use something, especially when you're talking about IO libraries. Examples themselves often don't even show the "correct" way, but rather just a way that will work in ideal circumstances.