Repository navigation
docs: fix install, preview-label, CONTRIBUTING and vLLM wording for 0.3.0 - #958
Conversation
Say that ROCm CLI ships two prebuilt binaries, `rocm` and `rocmd`, which is what install.sh installs. Use "Linux and WSL2", "because" and "Unix" in the dashboard note. Backport note for v0.3.0: cherry-pick onto release/v0.3.0. It only touches docs/rocm-docs/install/installation.md. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
Mark `rocm remote serve` in the Quick reference table, and the Chat, ComfyUI and Automations headings, as preview. The CLI help marks these commands `[preview]`, and the Remote machines heading already says so. Backport note for v0.3.0: cherry-pick onto release/v0.3.0. It touches README.md, which also changes the Getting started and Commands pages. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
Add the published Doctor catalog (doctor-catalog.json) to the generated files that prek checks. The cargo-catalog hook runs `cargo xtask catalog`, and CI runs it with `--check`. Backport note for v0.3.0: cherry-pick onto release/v0.3.0. It touches CONTRIBUTING.md, which also changes the Contributing page. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
Replace two "That same ..." openers in the ROCm 10.x wheel discovery section with the step they refer to. Wording only. Backport note for v0.3.0: cherry-pick onto release/v0.3.0. It touches docs/vllm.md, which also changes the vLLM adapter page. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
juhovainio
left a comment
There was a problem hiding this comment.
Docs-only change; I checked the claims against the repo and they hold: the [preview] markers exist in cli.rs for chat, comfyui, remote and automations, the doctor-catalog.json hook exists (cargo xtask catalog), and the vLLM rewrites are wording only. No internal-content hits in the diff, and the required CI checks (lychee, Sphinx -W, prek, commit signatures, clippy) are green.
Two non-blocking notes:
- Now that the install page says the release ships
rocmandrocmd,README.md:26anddocs/rocm-docs/index.rst:13still say "ships as a single prebuilt binary", and theREADME.md:20tagline says "one binary". Worth aligning in this PR or a follow-up. - The
(preview)heading renames change their anchors. In-repo links are fine, but any external deep link such as#chatwould stop resolving.
Small unmentioned edit: the "Linux and WSL2 / Unix socket" wording on the install page could be noted in the PR body.
| # Installing ROCm CLI | ||
|
|
||
| ROCm CLI ships as a single prebuilt binary. Platform support: | ||
| ROCm CLI ships as prebuilt binaries (`rocm` and `rocmd`). Platform support: |
There was a problem hiding this comment.
This is correct (the release builds both binaries), but README.md:26 and docs/rocm-docs/index.rst:13 still say "ships as a single prebuilt binary", and README.md:20 says "one binary". Worth aligning them.
There was a problem hiding this comment.
Addressed in 72e82df: the README and docs index now say rocm and rocmd, and the tagline is updated. I also added the anchor-rename note and the Linux/WSL2 Unix socket wording to the PR description.
r0x0r
left a comment
There was a problem hiding this comment.
I checked each of the four claims in this PR against the code, and they all hold up. The content is accurate as far as it goes:
chat,comfyui,remoteandautomationsreally are marked[preview]in the CLI help (apps/rocm/src/cli.rs:305,594,605,610), so the README headings now match what users actually see.- The CONTRIBUTING change is right too: the cargo-catalog hook sits at
.pre-commit-config.yaml:237and CI runscargo xtask catalog --check(.github/workflows/ci.yml:1438), sodoctor-catalog.jsondoes belong in that list. - Both rewritten vLLM sentences name the step they actually refer to.
- And the install page is correct to say two binaries:
install.sh:565andxtask/src/package.rs:131both requirebin/rocmandbin/rocmd.
I also checked the two things that usually break when headings change, and neither is a problem here: nothing in the tree links to ](#chat), ](#comfyui) or ](#automations), and no Sphinx :start-after: marker keys off those headings. All 32 checks are green, and a trial merge with #957 is clean (checked with git merge-tree).
So none of my objections are about the wording itself. They're about completeness and metadata, and all three are cheap to fix:
README.md:26still carries the exact single-binary claim this PR corrects on the install page, in a file this PR already edits.- The fix only lands on
release/v0.3.0--mainstill has all four wrong statements, and the backport notes point at the branch the commits are already on. - The test plan names two checks that don't exist in the repo.
Details inline.
| | `rocm install driver` | Install the AMD kernel driver on Linux; on Windows, report the display driver version and age (installs nothing) | | ||
| | `rocm serve <model>` | Start a local OpenAI-compatible model server | | ||
| | `rocm remote serve <machine> <model>` | Serve a model on another GPU machine over your private network | | ||
| | `rocm remote serve <machine> <model>` (preview) | Serve a model on another GPU machine over your private network | |
There was a problem hiding this comment.
(Anchored on this line because GitHub only accepts comments on diff lines -- the line I actually mean is README.md:26, with related context at line 20.)
README.md:26 still says ROCm CLI "ships as a single prebuilt binary for Linux and Windows" -- the very claim this PR corrects on the install page. The new install wording is the right one: install.sh:565 and xtask/src/package.rs:131 both require bin/rocm and bin/rocmd, so installation.md:9 is now accurate. But the stale sentence survives in a file this PR already touches, and AGENTS.md section 5 asks for an old claim to be grepped across surfaces before pushing.
The same one-line correction in README.md closes it.
There was a problem hiding this comment.
Fixed in 72e82df. README.md:26 and docs/rocm-docs/index.rst:13 now say the release ships rocm and rocmd. I also changed the README.md:20 tagline to "one install, zero setup". I grepped the README, docs and CONTRIBUTING for "single binary", "one binary" and "single prebuilt binary" and found no other hits.
| # Installing ROCm CLI | ||
|
|
||
| ROCm CLI ships as a single prebuilt binary. Platform support: | ||
| ROCm CLI ships as prebuilt binaries (`rocm` and `rocmd`). Platform support: |
There was a problem hiding this comment.
(This finding is about where the fix lands rather than about this line; I anchored it here because this is the install wording it concerns.)
All four corrections only exist on release/v0.3.0. origin/main still carries every one of the wrong statements -- installation.md:9, the ### Chat / ### ComfyUI / ### Automations headings in README.md, CONTRIBUTING's "generated manifests", and vllm.md:144,149 -- and no open PR targets main. Meanwhile all four commits (d200182, 6027de6, 836d1de, 3517f2c) carry a note saying "cherry-pick onto release/v0.3.0", which is the branch they already sit on, so nothing directs the forward-port.
Either open the matching PR against main, or say in the description that main is being handled separately.
There was a problem hiding this comment.
Thanks. This PR targets release/v0.3.0 on purpose. Once it and #957 both merge, I'll open one combined forward-port PR to main, cherry-picked with -x. I've updated the PR description to say so and will link the PR there when it's open. I'm waiting for both to land first because #957 touches nearby lines, so doing it now would mean resolving conflicts twice. I'm not rewriting the "cherry-pick onto release/v0.3.0" notes in the four commits, to avoid churn and re-signing on an approved PR. The description covers the forward-port plan.
| index's 403 as fatal. | ||
|
|
||
| That same full-dependency resolve can also pull in an unconstrained `torch` | ||
| The full-dependency resolve in that final install can also pull in an unconstrained `torch` |
There was a problem hiding this comment.
(Anchored here for want of a diff line -- this finding is about the PR description.)
The test plan cites check_docs_sync.py and pr_preflight.py. Neither exists in the repo: I checked this PR's head, origin/release/v0.3.0 and origin/main with git ls-tree -r, and both files are absent from all three. The sphinx -W part of the plan does hold -- the "Sphinx docs build (-W)" check is green.
Worth naming the gates that actually ran.
There was a problem hiding this comment.
Fixed. I removed check_docs_sync.py and pr_preflight.py from the test plan, which now lists the CI checks that ran: Sphinx -W, lychee, prek, commit signatures and clippy.
|
@r0x0r all three points are addressed (see the replies and the updated description). Could you re-review? |
Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
72e82df to
1c048ef
Compare
Resolve conflicts with the 0.3.0 copyedit PR: take its README wording for the two-binaries sentence and drop docs/rocm-docs/index.rst, which that PR replaced with index.md. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
|
@r0x0r merging with @juhovainio's approval since your three points are addressed above. Please follow up here if anything is still off and I will pick it up. |
Corrects statements that the 0.3.0 docs review found wrong or inconsistent.
rocmandrocmd. The READMEand docs index now say the same, and the banner tagline reads "one install,
zero setup".
Unix socket.
rocm remote serve, Chat, ComfyUI and Automations are labeledpreview, matching the CLI help. The renamed headings change their anchors
(for example
#chat). Nothing in the repo links to the old anchors, butexternal deep links to them will stop resolving.
checks.
One commit per page, plus one commit for the README and docs index binaries
wording.
Targets
release/v0.3.0only.mainstill has these statements. Oncethis PR and #957 both merge, a single combined forward-port PR to
mainwillfollow (cherry-picked with
-x). Link to be added here when it is open.A trial merge with
docs/0.3.0(#957) is clean, because these edits avoid thelines that PR changes.
Not included yet: the
--allow-public-bindprose (waits for #957 to merge)and the vLLM install and 10.x summary wording (waits for a maintainer answer).
Test plan (checks that ran in CI):
-W)