Repository navigation
docs: port editorial copyedits and WSL2 guide to the v0.2.0 docs - #711
Draft
pmoutsias-amd wants to merge 3 commits into
Draft
pmoutsias-amd wants to merge 3 commits into
pmoutsias-amd wants to merge 3 commits into
Conversation
* docs: publish the WSL2 guide on the docs site
Add an Install page, ROCm CLI on WSL2, that single-sources the
published sections of docs/wsl.md (prerequisites, ROCDXG install,
diagnosing a WSL host, and what `rocm examine` reports). Maintainer
notes in docs/wsl.md stay unpublished.
Copyedit the published sections for the style guide, replace the
hard-coded ROCDXG version and digest in the by-hand install steps with
placeholders, and say which `rocm examine` fields appear only in the
JSON output. Link the page from the installation page.
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: move the WSL2 guide link out of the platform table
The table is single-sourced into the installation page, where the
GitHub URL in the WSL2 row sat next to the internal link to the new
WSL2 page. Drop it from the row and link docs/wsl.md from a sentence
after the table in the README instead.
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: add the WSL2 page to the docs index
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* ci(docs): build the docs site when docs/wsl.md changes
The new WSL2 page single-sources docs/wsl.md through MyST `{include}`
directives, so an edit to that file alone must not skip the `-W` docs
build. Adds it to the `docs:` path filter alongside docs/vllm.md.
Co-Authored-By: Claude Code <noreply@anthropic.com>
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: tighten WSL2 guide wording per review
Use "ROCm CLI" instead of rocm-cli in prose, attribute the non-login
shell to the explicit /bin/sh -c rather than wsl.exe --exec, and rewrap
an overlong line.
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: clarify the host-side WSL diagnose form and define the catalog
Explain what `rocm diagnose --distro` does, what "the same catalog"
means, and define "WSL catalog" at its first use in the published page.
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: name the --distro form as the subject of the WSL limitation bullets
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: move --distro detail into a WSL subsection and tighten claims
Move the host-side diagnose detail out of Prerequisites into a "Diagnose
a distro from Windows" subsection, state the limits as facts, and add
WSL1 and non-Ubuntu abstention notes. Keep the devs' 7.13+ wording for
HSA_ENABLE_DXG_DETECTION and add a Next steps link on the install page.
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: link WSL page references to site pages
Turn the text references in the single-sourced WSL sections into links:
same-page anchors for the prerequisites and diagnose sections, and
cross-page links to the command reference and installation guide. The
includes use :relative-docs: so the links resolve as site pages.
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: retarget WSL installation-guide link to the docs site
Copy the "Diagnose a distro from Windows" lead-in sentence into the
wrapper so its installation-guide link resolves within the site, and
split the include around it.
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
* docs: address review feedback on the WSL2 page
- Drop the site cross-links from docs/wsl.md that lychee cannot resolve
(the headings live only in README.md); link the installation guide to
README.md, and add a Command reference link to the site wrapper.
- Mark the four rocm examine items that appear only in --json output.
- Add the rocminfo/PATH limit to the --distro limits and say that the
shared checks (fix-1, fix-2, fix-6, fix-8, fix-16) also run on WSL.
- List fix-18 and fix-19 as skipped under --distro in the README.
- Return to "legacy ROCm release" without an unsourced version bound.
- Reword the manual-install trust claim: the CLI checks a digest pinned
in the source, which a digest read from the release page does not match.
Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
* docs: list the shared WSL checks exactly and drop the inert relative-docs option
The shared-checks paragraph in docs/wsl.md said fix-16-vllm-oom reads the
environment or the ROCm install and called fix-18 not an environment check.
fix-16 is driven by the --symptom text alone, and fix-18 reads the loader
path and the ROCm install. List the seven shared entries (fix-1, fix-2,
fix-6, fix-8, fix-16, fix-18, fix-19) exactly, without "such as".
Remove :relative-docs: from the four includes in install/wsl.md. MyST
rewrites a link only when it starts with the option's value, and no
included range of docs/wsl.md has a link starting with rocm-docs/, so the
option had no effect.
Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
---------
Signed-off-by: pmoutsias-amd <peter.moutsias@amd.com>
Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
Co-authored-by: Claude <noreply@anthropic.com>
Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
pmoutsias-amd
force-pushed
the
docs/v0.2.0-release-docs
branch
from
October 19, 2026 15:25
64e2bbf to
d1ec061
Compare
….2.0 docs Docs-only. Audited against the v0.2.0 code: omits post-v0.2.0 behavior text and marks ROCm 10 as a preview with a known issue (torchaudio resolution). Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
State that ROCm CLI supports ROCm 7.14 as well as ROCm 10 and newer, name 7.14 as the default and 10.1.0 as the working ROCm 10 install, and record that --version 10.0.0 currently fails as a known issue in the README, the command reference, and the vLLM page. Regroup the Getting started intro so the --family guidance follows the version facts. Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
pmoutsias-amd
force-pushed
the
docs/v0.2.0-release-docs
branch
from
October 19, 2026 18:07
6e525b1 to
1f1e208
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
release/v0.2.0so the published docs can be built from this branch.--helpwording edits inmain.rsare not included.--version 10.0.0fails on torchaudio, and10.1.0works only while it is the newest ROCm 10 build on the package index. The example now uses10.1.0.Test plan
docs-buildpasses and the Sphinx site renders the README, vLLM, and WSL2 includesdocs-linkspasses