Repository navigation
docs: publish the WSL2 guide on the docs site - #627
Draft
pmoutsias-amd wants to merge 7 commits into
Draft
pmoutsias-amd wants to merge 7 commits into
pmoutsias-amd wants to merge 7 commits into
Conversation
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: pmoutsia_amdeng <peter.moutsias@amd.com>
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: pmoutsia_amdeng <peter.moutsias@amd.com>
Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
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>
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: pmoutsia_amdeng <peter.moutsias@amd.com>
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: pmoutsia_amdeng <peter.moutsias@amd.com>
…lets Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: pmoutsia_amdeng <peter.moutsias@amd.com>
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
docs/wsl.md(prerequisites, ROCDXG install, diagnosing a WSL host, and whatrocm examinereports) through anchored includes. The maintainer sections (runtime env design, install UX recommendations, test plans) stay unpublished.docs/wsl.mdfor the style guide.ROCDXG_VERSIONandROCDXG_SHA256placeholders, so they can't go stale.rocm examinefields appear only in--jsonoutput._toc.yml.in.Split out of #616 so that PR stays a copyedit. The legacy ROCm / 7.13 hedge in the Windows SDK section is unchanged from the original.
Test plan
sphinx-build -W --keep-going -b htmlindocs/rocm-docspasses on this branch.driver_install.rs,fix.rs,diagnose.rs, andexamine.rs, and against a liverocm examineandrocm examine --jsonrun on a WSL2 host.curl,sha256sum -c,apt install) have not been run end to end; the filename and URL match whatrocm install driverbuilds.wsl.exe --execruns a non-login shell is supported by the source (examine.rs) but was not tested empirically.