basic documentation for everything

[andrewrk]

I started the effort here: http://ziglang.org/documentation/master/

If anyone wants to help you can submit a pull request to edit doc/langref.html.in. It's processed with doc/docgen.zig

[raulgrell]

Cracks knuckles

I got yo' back, son!

[tiehuis]

Just a note; I'm in the process of writing some documentation for the current TODO items. I'll save a pull-request and review until I have a fair few done, but will be periodically pushing here.

e.g. https://github.com/tiehuis/zig-notes/blob/master/enum.zig

[andrewrk]

TODO list:

• "expression value is ignored"
• explain why a << b b is the Log2 integer size
• add to standard library: parse floats #375
• Slices
• Pointers
• wrong order of bits in bit fields #307
• unreachable
• Errors
• Nullables
• alignment
• bit fields
• Casting
• void
• this - instead of documenting it we'll remove it. see remove this #1283
• comptime
• Assembly
• Atomics
• is <<% even "wrapping" around? or is it just truncating? maybe it shouldn't be one of the % operators?
• add compile error for division by zero #372
• undefined behavior for exact division remainder
• undefined behavior for slice widen remainder
• undefined behavior for invalid enum cast
• Root Source File
• Zig Test
• Zig Build System
• a more complex @cInclude example that has multiple includes and demonstrates compile time control flow and @cDefine, @cUndef, etc.
• move to ziglang.org/documentation/master/index.html to make room for ziglang.org/documentation/0.1.0/index.html
• move docs to zig repo
• async/await/coroutines
• add || to operator list and precedence section
• setting the section on global variables and functions
• labeled break and continue
• noalias
• extern struct
• labeled blocks and loops
• clarify that @setFloatMode is inherited by blocks

[0joshuaolson1]

I'm really curious about the build system (e.g. to see how it compares in maturity/scope with a wannabe cmake killer I'm following). Is the code the best docs (and where?), or has some contributor somewhere started on it?

Is deterministic package management in scope? Maybe the docs could link to umbrella/section-specific issues about their future plans?