Luigit
repositories / termux-janitor

termux-janitor

Interactive cleanup assistant for Termux: transparent, safe, confirmed disk reclamation.

owned by admin

spec/ZIG_DOCUMENTATION.md

Raw
Rendered preview

Zig documentation

Use the repository-pinned Zig executable because its bundled documentation and source match the compiler.

  • Run zig --help or zig <command> --help before relying on remembered CLI syntax.
  • Run zig std to serve the bundled standard-library documentation. Without a browser, inspect zig std --help, disable browser opening, and query the printed local URL while the server runs.
  • Run zig env to locate std_dir, then search that tree for declarations, doc comments, and tests. Never assume an installation path.
  • Confirm uncertain API usage with the smallest compiling zig test case, then run the repository gates.

Use the official release index to identify the stable release and open its versioned language and standard-library documentation. Do not use master documentation for stable Zig.

# Zig documentation

Use the repository-pinned Zig executable because its bundled documentation and source match the
compiler.

- Run `zig --help` or `zig <command> --help` before relying on remembered CLI syntax.
- Run `zig std` to serve the bundled standard-library documentation.
  Without a browser, inspect `zig std --help`, disable browser opening, and query the printed local
  URL while the server runs.
- Run `zig env` to locate `std_dir`, then search that tree for declarations, doc comments, and tests.
  Never assume an installation path.
- Confirm uncertain API usage with the smallest compiling `zig test` case, then run the repository
  gates.

Use the official [release index](https://ziglang.org/download/) to identify the stable release and
open its versioned language and standard-library documentation.
Do not use `master` documentation for stable Zig.