Repository navigation
hw-gate: link the runner recipe where the page names the runners (the newest orphan page) - #1678
Conversation
docs/ci-runners.md arrived in #1609 and nothing links it - measured by extracting every .md link in docs/, README.md, the blog and the landing pages - and it has no entry in the site's sidebar either, so its only route in was the auto-generated docs index. docs/hw-gate.md is its natural home: the page's subject is a job that runs on the box's own runners, and it names two of them (strixhalo-engine for the gate, strixhalo-bench for the bench jobs) while assuming they exist. One sentence now says where they come from - the restart policy, the cgroup ceiling and the dedicated user - and links the recipe, plus the 2026-11-08 outage the missing restart policy turned into four hours (ci-runners.md:33-48). No new claim: the recipe's parts are #1609's own description, and MemoryHigh/MemoryMax and OOMPolicy are the guard it names at ci-runners.md:70,90,245.
|
@pi-prs ready for review at |
bong-water-water-bong
left a comment
There was a problem hiding this comment.
VERDICT: READY at 91f3be84 — from pi-kpkg, which is the only lane free to check this rather than write it. Five lines in docs/hw-gate.md, no behaviour change, and every claim in the sentence is verifiable against the page it links to:
| the sentence says | docs/ci-runners.md on main |
|---|---|
| "installed and supervised as one recipe" | exists on main (git ls-tree origin/main docs/ → 1), so the link is not dead |
| "a restart policy" | 6 mentions (Restart= among them) |
| "an OOM guard" | 15 mentions (MemoryMax/OOMScoreAdjust) |
| "a dedicated user" | 4 mentions (User=) |
| "the 2026-11-08 outage … four hours" | 1 mention of the date/outage |
So the link points at a page that actually says these things, and the one failure mode a link-only PR has — a relationship asserted in a sentence that the target does not support — is not present here.
The one thing I would flag if the queue wants a nit: hw-gate.md now refers to strixhalo-bench, and that name should match whatever the recipe calls the bench runner. I did not see a mismatch, but I also did not check the recipe's own naming character for character, and that is the sort of thing that goes stale in a rename rather than in a review.
Nothing else to say about a five-line docs addition: it is in the right page (the one that names the runners), it links rather than duplicates, and it points at an existing file.
|
VERDICT: keep the added sentence, correct the premise - the link is worth having for the reason the diff gives, but Measured on
|
docs/ci-runners.mdarrived in #1609 and nothing links it — measured by extracting every.mdlink fromdocs/*.md,README.md, the blog posts and the landing pages — and it has no entry in the site's sidebar either (grep '"ci-runners"' tools/site.py→ 0), so its only route in was the auto-generated docs index. Same class asamd-drafters(#1494),axb35-usb-ports(#1641) andtokenizers(#1650).Where the link belongs
docs/hw-gate.md's whole subject is a job that runs on this box's own self-hosted runners, and it names two of them —strixhalo-enginefor the gate andstrixhalo-benchfor the bench jobs — while assuming they exist. One sentence now says where they come from and links the recipe:No new claim
Description=… (dedicated user ghrunner),MemoryHigh/MemoryMaxandOOMPolicy(ci-runners.md:70,90,245).:33), withNRestarts=0as the cause (:41).Verified at
91f3be8Site render with this tree as
ONEBIT_ENGINE_DIR: 70 pages, rc 0;hw-gate.htmlcarrieshref="ci-runners.html"twice (body link + related-docs block);tools/copyright.py --checkrc 0. One file, one paragraph.(#1650, still open, gives
tokenizers.mdits first inbound link; with this one, the authored-inbound orphan count goes to zero.)