Skip to content

docs: port v0.1.0 doc restructure from main (PR #473) - #525

Draft
pmoutsias-amd wants to merge 1 commit into
docs/v0.1.0from
docs/v0.1.0-pr473-port
Draft

pmoutsias-amd wants to merge 1 commit into
docs/v0.1.0from
docs/v0.1.0-pr473-port

Conversation

@pmoutsias-amd

Copy link
Copy Markdown
Contributor

Summary

Ports the doc changes from #473 (merged to main) 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. The README and docs/vllm.md prose describing those
stays out, so this is a curated port rather than a cherry-pick of #473's
commits.

README

  • Split the install sdk prose into subsections and add a ##### ROCm 10 and newer heading. The --devel subsection is omitted because the flag does not
    exist on this branch.
  • Editorial: the approval-prompt sentence, the
    --approve-replacing-active-default and install-location line wraps, the
    update table's Effect -> Description rename 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.

vLLM topic

  • docs/vllm.md: heading promotion, ROCm CLI naming throughout, the env-var
    placeholder rewording, and the Related resources titled links. The
    --devel source-build paragraph is omitted.
  • Adds docs/rocm-docs/engines/vllm.md, transcluding docs/vllm.md.
  • Regroups index.rst and _toc.yml.in: Demos under Getting started, and
    Commands -> Use ROCm CLI with Command reference before vLLM adapter.
  • Adds the Command reference intro sentence and the getting-started copy
    comment, and swaps installation.md's vLLM link for the new page.

CI

  • Adds docs/vllm.md to the docs: path filter. The new page transcludes it,
    so a later edit to that file alone must not skip the -W docs build.

Test plan

  • Sphinx docs build (-W) passes with no warnings
  • New vLLM adapter page renders in the nav
  • Every :start-after: anchor in the including pages still matches
    README.md exactly once

Docs-only change: no CLI behavior changes, so no test scenario is needed. The
-W docs build is what validates it.

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant