ziglang/ziglang.org
14
29
Fork
You've already forked ziglang.org
31

Additional build system documentation? #561

Open
opened 2025年11月01日 03:31:09 +01:00 by zmitchell · 1 comment

Hi, I'm digging into the build system and wanted to see if you would be accepting of additional documentation. My thinking is that the current build system documentation walks you through how to write certain build programs, but doesn't explain the entities involved e.g. "executable", "module", "step", "install artifact", etc.

So, what I was thinking of contributing is a small section that explains those differences so that readers know which b.* method to call and when. As a new user myself, and because my current understanding is lacking, my current strategy is to guide myself by compiler/build system errors until something works properly. I'm hoping that we can provide a mental model that users can internalize.

Hi, I'm digging into the build system and wanted to see if you would be accepting of additional documentation. My thinking is that the current build system documentation walks you through _how_ to write certain build programs, but doesn't explain the entities involved e.g. "executable", "module", "step", "install artifact", etc. So, what I was thinking of contributing is a small section that explains those differences so that readers know which `b.*` method to call and when. As a new user myself, and because my current understanding is lacking, my current strategy is to guide myself by compiler/build system errors until something works properly. I'm hoping that we can provide a mental model that users can internalize.

I added a draft PR with a first stab at this.

I added a draft PR with a first stab at this.
Sign in to join this conversation.
No Branch/Tag specified
main
release-0.16.0
apraga/french
homersimpsons/fix/mobile-responsiveness
MarkLagodych/patch-1
Zirunis/patch-1
zmitchell/zmitchell/build-graph-docs
generalmimon/fix-unit-testing-examples
generalmimon/fix-code-snippet-in-0.15.1-relnotes
TheConnorJohnson/main
meeting-minutes
enkvadrat/update-curl-example
No results found.
Labels
Clear labels
bounty
https://ziglang.org/news/announcing-donor-bounties
bug
Observed behavior contradicts documented or intended behavior.
contributor-friendly
This issue is limited in scope and/or knowledge of project internals.
downstream
An issue with a third-party project that uses this project.
enhancement
Solving this issue will likely involve adding new logic or components to the codebase.
infra
An issue related to project infrastructure, e.g. continuous integration.
optimization
A task to improve performance and/or resource usage.
question
No questions on the issue tracker; use a community space instead.
regression
Something that used to work in a previous version stopped working
upstream
An issue with a third-party project that this project uses.
use case
Describes a real use case that is difficult or impossible, but does not propose a solution.
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
ziglang/ziglang.org#561
Reference in a new issue
ziglang/ziglang.org
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?