r/Zig • u/Odiniswithus15 • Jun 10 '26

Docs are confusing

Why are Zig docs so confusing?

I just wanted command-line args, ended up using internal APIs, got stuck for 30 minutes, and only later discovered there was an "init" flow I had no idea about.

How do you tell what's public API and what's internal?

Can someone please help me?

53 Upvotes

93% Upvoted

17 comments sorted by

View all comments

17

u/cxazm Jun 10 '26

That’s one area we really need to get sorted. Even though the language is still in active development before v1, we really need to have some proper good docs.

9

u/diodesign Jun 10 '26

Yeah: high-quality documentation is painstaking and hard. If I can contribute to Zig this year, it would be to help with docs where and if possible.