ROCm Container Documentation Standards RFC

[LiamfBerry]

Motivation

ROCm's container catalog spans 93 Docker Hub repos, and the Docker Hub overview is the first — often the only — documentation a user sees before pulling an image. Today those overviews are inconsistent or absent: the most-pulled Core SDK/Runtime image, rocm/dev-ubuntu-24.04 (100K+ pulls), shows "No overview available" — no prerequisites, no run command beyond a bare docker pull, no support contact, no security information. There is no shared definition of what a ROCm container's documentation must contain, so each repo documents (or doesn't) on its own terms.

Technical Details

This RFC defines the documentation standard every ROCm Core SDK/Runtime container must meet. It is a companion to the naming, tagging, layering, and lifecycle rules in RFC0013 — ROCm Core SDK & Runtime Container Standardization; RFC0013 references this document as the authoritative source for the documentation requirement.

JIRA ID
ROCM-28753

Test Plan

N/A

Test Result

N/A

Submission Checklist

• Look over the contributing guidelines at https://github.com/ROCm/TheRock/blob/main/CONTRIBUTING.md.

[therock-pr-bot]

✅ All Checks Passed — Ready for Review

Check	Status	Details
📝 PR Description	✅ Pass	—
⛔ Forbidden Files	✅ Pass	—
🧪 Unit Test	✅ Pass	PR does not contain code files — Unit Test auto-passed
🔎 pre-commit	✅ Pass	—
🚫 Draft PR	🔜 To Be Enabled	—
🚩 Feature Flag	🔜 To Be Enabled	—
📊 Code Coverage	🔜 To Be Enabled	—
🤖 therock-pr-bot	✅ Pass	—

🎉 All checks passed! This PR is ready for review.

📖 Need help? See the Policy FAQ for details on every check and how to fix failures.

🙋 Wish to Override Policy?

[therock-pr-bot]

🎉 All checks passed! This PR is ready for review.

[therock-pr-bot]

Pre-commit check failed

⛔ pre-commit failed

Please run locally:

• python -m pip install pre-commit
• pre-commit install
• pre-commit run --all-files --show-diff-on-failure

This repo uses .pre-commit-config.yaml.