Skip to content

Reorganize docs to prioritize CDI over runtime#130

Merged
sgopinath1 merged 1 commit into
ROCm:mainfrom
shiv-tyagi:docs/reorg-cdi-first
Jun 2, 2026
Merged

Reorganize docs to prioritize CDI over runtime#130
sgopinath1 merged 1 commit into
ROCm:mainfrom
shiv-tyagi:docs/reorg-cdi-first

Conversation

@shiv-tyagi

@shiv-tyagi shiv-tyagi commented Jun 2, 2026

Copy link
Copy Markdown
Member

Summary

  • Moves the CDI guide right after Quick Start Guide in navigation and renames it to "Container Device Interface"
  • Splits Quick Start Guide into two sections: "Installing the Container Toolkit" (Steps 1–4) and "Configuring Docker Runtime" (steps reset to 1–2), with a seealso box pointing to CDI before the Docker section
  • Updates framework integration examples to use CDI device notation (--device amd.com/gpu=<entry>)
  • Reorders README quick start and usage sections to present CDI as Option A and runtime as Option B
  • Fixes a broken Markdown-style link in the Quick Start Guide note (was using [text](path) in an RST file)

Test plan

  • Build docs locally with sphinx-build and verify navigation order
  • Verify CDI guide appears right after Quick Start Guide in the sidebar
  • Verify all cross-reference links resolve (especially the fixed troubleshooting link)
  • Review README rendering on GitHub

- Move CDI guide right after Quick Start Guide in nav and rename to
  "Container Device Interface"
- Split Quick Start Guide into "Installing the Container Toolkit" and
  "Configuring Docker Runtime" with step numbers reset; add seealso
  pointing to CDI before the Docker section
- Update framework integration examples to use CDI device notation
- Reorder README quick start and usage to present CDI as Option A
- Fix broken Markdown-style link in Quick Start Guide note (use RST
  cross-reference instead)
@sgopinath1 sgopinath1 merged commit e0f8dbd into ROCm:main Jun 2, 2026
3 checks passed
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.

2 participants