docs: port v0.1.0 doc restructure from main (PR #473) - #525
Draft
pmoutsias-amd wants to merge 1 commit into
Draft
pmoutsias-amd wants to merge 1 commit into
pmoutsias-amd wants to merge 1 commit into
Conversation
Bring PR #473's editorial and structural changes onto the 0.1.0 docs, minus every description of functionality that shipped after the 0.1.0 cut. The 0.1.0 branch has no `rocm remote`, no `rocm install sdk --devel` toolchain concept, no `rocm services list --json`, and none of the prune-wait or storage-report additions, so the README and docs/vllm.md prose that describes them stays out. README: - Split the `install sdk` prose and add a `##### ROCm 10 and newer` heading; omit the `--devel` subsection. - Editorial: approval-prompt sentence, `--approve-replacing-active-default` and install-location line wraps, update table `Effect` -> `Description` with the `--apply` "never prompts" wording, the "Nothing about this happens on its own" paragraph, and the em-dash -> period fix in the `qwen` serve paragraph. docs/vllm.md: - Heading promotion and `ROCm CLI` naming throughout, the env-var placeholder rewording, and the Related resources titled links. Omit the `--devel` source-build paragraph. - The result is byte-identical to main's file except that paragraph. Docs site: - Add docs/rocm-docs/engines/vllm.md, transcluding docs/vllm.md. - Regroup index.rst and _toc.yml.in: Demos under Getting started, Commands -> Use ROCm CLI with Command reference before vLLM adapter. - Add the Command reference intro sentence, the getting-started copy comment, and swap installation.md's vLLM link for the new page. CI: - Add docs/vllm.md to the docs path filter, since the new page transcludes it and a later edit to it alone must not skip the -W docs build. Verified with the same Sphinx build CI runs, `sphinx-build -W`: the new page renders and the nav resolves with no warnings. Every `:start-after:` anchor in the including pages still matches README.md exactly once. Signed-off-by: pmoutsias-amd <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
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
Ports the doc changes from #473 (merged to
main) onto the 0.1.0 docs, minusevery description of functionality that shipped after the 0.1.0 cut.
The 0.1.0 branch has no
rocm remote, norocm install sdk --develtoolchainconcept, no
rocm services list --json, and none of the prune-wait orstorage-report additions. The README and
docs/vllm.mdprose describing thosestays out, so this is a curated port rather than a cherry-pick of #473's
commits.
README
install sdkprose into subsections and add a##### ROCm 10 and newerheading. The--develsubsection is omitted because the flag does notexist on this branch.
--approve-replacing-active-defaultand install-location line wraps, theupdate table's
Effect->Descriptionrename with the--apply"neverprompts" wording, the "Nothing about this happens on its own" paragraph, and
the em-dash -> period fix in the
qwenserve paragraph.vLLM topic
docs/vllm.md: heading promotion,ROCm CLInaming throughout, the env-varplaceholder rewording, and the Related resources titled links. The
--develsource-build paragraph is omitted.docs/rocm-docs/engines/vllm.md, transcludingdocs/vllm.md.index.rstand_toc.yml.in: Demos under Getting started, andCommands -> Use ROCm CLI with Command reference before vLLM adapter.
comment, and swaps
installation.md's vLLM link for the new page.CI
docs/vllm.mdto thedocs:path filter. The new page transcludes it,so a later edit to that file alone must not skip the
-Wdocs build.Test plan
-W) passes with no warnings:start-after:anchor in the including pages still matchesREADME.mdexactly onceDocs-only change: no CLI behavior changes, so no test scenario is needed. The
-Wdocs build is what validates it.