Skip to content

docs: neutral wording for the release-side add-on and its pins - #547

Merged
bong-water-water-bong merged 2 commits into
mainfrom
buildsecrecy-docs-wording
Oct 24, 2026
Merged

bong-water-water-bong merged 2 commits into
mainfrom
buildsecrecy-docs-wording

Conversation

@bong-water-water-bong

Copy link
Copy Markdown
Collaborator

docs: neutral wording for the release-side add-on and its pins

Housekeeping on the public pages so the release-side component naming is consistent with what
docs/releases.md already says ("Private components"): the private kernel add-on is referred to by
what it is rather than by a repository name, its pins stay as the opaque identifiers they are, and an
internal kernel-side type name is dropped from the hardware-gate page (the failure it documents is
described by what went wrong, not by the symbol).

No behaviour, no build change: docs/hrx.md, docs/hw-gate.md, docs/releases.md, one comment in
cmake/hrx.cmake, and two comments in scripts/hw-gate.sh.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

PR Reviewer Guide 🔍

(Review updated until commit 1c8b4ff)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Inconsistent Documentation

The documentation in docs/hrx.md still refers to the private HIP kernels as a "private kernel add-on" in one instance, but earlier in the same table it refers to it as "a private kernel add-on (not a submodule: a build points at a checkout with -DONEBIT_GPU_PRIVATE)". This inconsistency could confuse readers about whether the add-on is a submodule or not, and should be made consistent.

| private HIP kernels | a private kernel add-on (not a submodule: a build points at a checkout with `-DONEBIT_GPU_PRIVATE`) | `4f586cac` — the commit the release builds and the hardware gate were run at |

@bong-water-water-bong

Copy link
Copy Markdown
Collaborator Author

Review (orchestrator): neutral and accurate; the pin table keeps the identifiers, the gate page describes the failure without the symbol. Mark ready when the origin classification for the audit's leaks 1-3 is in; merges on green CI.

@bong-water-water-bong
bong-water-water-bong marked this pull request as ready for review October 24, 2026 06:59
@github-actions

Copy link
Copy Markdown

Persistent review updated to latest commit 7dfc0bd

1 similar comment
@github-actions

Copy link
Copy Markdown

Persistent review updated to latest commit 7dfc0bd

Housekeeping on the public pages so the release-side component naming is consistent with what
`docs/releases.md` already says ("Private components"): the private kernel add-on is referred to by
what it is rather than by a repository name, its pins stay as the opaque identifiers they are, and an
internal kernel-side type name is dropped from the hardware-gate page (the failure it documents is
described by what went wrong, not by the symbol).

No behaviour, no build change: `docs/hrx.md`, `docs/hw-gate.md`, `docs/releases.md`, one comment in
`cmake/hrx.cmake`, and two comments in `scripts/hw-gate.sh`.

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@github-actions

Copy link
Copy Markdown

Persistent review updated to latest commit 36b0c1a

@bong-water-water-bong

Copy link
Copy Markdown
Collaborator Author

Merging on green CI.

@github-actions

Copy link
Copy Markdown

Persistent review updated to latest commit 1c8b4ff

@bong-water-water-bong
bong-water-water-bong merged commit ed6cf92 into main Oct 24, 2026
8 checks passed
@bong-water-water-bong
bong-water-water-bong deleted the buildsecrecy-docs-wording branch October 24, 2026 07:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant