Skip to content

docs: clarify community hardware listings#3846

Open
jpc204 wants to merge 7 commits into
NVIDIA:mainfrom
jpc204:agent/document-community-platforms
Open

docs: clarify community hardware listings#3846
jpc204 wants to merge 7 commits into
NVIDIA:mainfrom
jpc204:agent/document-community-platforms

Conversation

@jpc204

@jpc204 jpc204 commented Jul 22, 2026

Copy link
Copy Markdown

Description

  • Clarify that contributors must update the Hardware Compatibility List after adding platform support.
  • Require a responsible contact and a corresponding GitHub issue or discussion reference for questions, issues, and implementation context.
  • Separate NVIDIA-maintained platforms from a new Coming Soon: Community-Added Platforms section.

Related issues

None.

Type of Change

  • Add - New feature or capability
  • Change - Changes in existing functionality
  • Fix - Bug fixes
  • Remove - Removed features or deprecated functionality
  • Internal - Internal changes (refactoring, tests, docs, etc.)

Breaking Changes

  • This PR contains breaking changes

Testing

  • No testing required (docs, internal refactor, etc.)

Validated both edited Markdown files for trailing whitespace and unresolved relative links, and ran git diff --check.

Signed-off-by: Jared Conway <jaredc@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented Jul 22, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@coderabbitai

coderabbitai Bot commented Jul 22, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Summary by CodeRabbit

  • Documentation
    • Updated hardware support guidance to require corresponding Hardware Compatibility List updates, including contributor contact details and contribution links.
    • Reorganized the Hardware Compatibility List with clearer sections for NVIDIA-maintained platforms, hosts, platforms under development, and DPUs.
    • Added a section for upcoming community-added platforms and refreshed the “Last Updated” date.

Walkthrough

The documentation now requires new hardware contributions to update the Hardware Compatibility List with ownership and traceability details. The HCL structure groups NVIDIA-maintained platforms and adds sections for under-development and community-added platforms.

Changes

Hardware support documentation

Layer / File(s) Summary
Contribution requirements
docs/development/new_hardware_support.md
Requires contributors to update the Hardware Compatibility List with responsible contact information and a link to the contribution.
Hardware Compatibility List structure
docs/hcl.md
Introduces the NVIDIA-maintained platforms hierarchy, updates the date format, relocates under-development host and DPU sections, and adds a community-added platforms section stating that none are currently listed.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately reflects the docs change around community hardware listings and stays concise.
Description check ✅ Passed The description matches the documented changes to HCL requirements and platform section reorganization.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Comment @coderabbitai help to get the list of available commands.

jpc204 added 2 commits July 22, 2026 11:34
updated agent copy

Signed-off-by: jpc204 <50123158+jpc204@users.noreply.github.com>
updated agent copy

Signed-off-by: jpc204 <50123158+jpc204@users.noreply.github.com>
@jpc204
jpc204 marked this pull request as ready for review July 22, 2026 15:36
@jpc204
jpc204 requested a review from polarweasel as a code owner July 22, 2026 15:36
@github-actions

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/development/new_hardware_support.md`:
- Line 9: Update the hardware support documentation text to capitalize the
platform name as “GitHub” wherever it appears in the referenced sentence,
without changing the surrounding content.
- Around line 9-10: Update the contributor guidance in
docs/development/new_hardware_support.md lines 9-10 to explicitly require a
related GitHub issue or discussion link alongside the responsible contact
information and contribution link. Update docs/hcl.md lines 69-74 so every
future community-platform entry also includes that related issue or discussion
reference.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 0f623aa3-9442-4c93-ad0a-542a15e6b357

📥 Commits

Reviewing files that changed from the base of the PR and between f5289a3 and b05c482.

📒 Files selected for processing (2)
  • docs/development/new_hardware_support.md
  • docs/hcl.md

Comment thread docs/development/new_hardware_support.md
Comment thread docs/development/new_hardware_support.md
Comment thread docs/hcl.md Outdated
Comment thread docs/hcl.md Outdated
jpc204 and others added 2 commits July 24, 2026 19:35
Co-authored-by: Alex Ball <awball@polarweasel.org>
Signed-off-by: jpc204 <50123158+jpc204@users.noreply.github.com>
Co-authored-by: Alex Ball <awball@polarweasel.org>
Signed-off-by: jpc204 <50123158+jpc204@users.noreply.github.com>

@polarweasel polarweasel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the date to the top for ya

Comment thread docs/hcl.md
Comment thread docs/hcl.md Outdated
jpc204 and others added 2 commits July 24, 2026 20:25
Co-authored-by: Alex Ball <awball@polarweasel.org>
Signed-off-by: jpc204 <50123158+jpc204@users.noreply.github.com>
Co-authored-by: Alex Ball <awball@polarweasel.org>
Signed-off-by: jpc204 <50123158+jpc204@users.noreply.github.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/hcl.md (1)

71-75: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Make the required traceability link explicit.

Require each community entry to link to the related GitHub issue or discussion, not just a generic “GitHub contribution,” so questions, issues, and implementation context remain discoverable.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/hcl.md` around lines 71 - 75, Update the “Coming Soon: Community-Added
Platforms” documentation to explicitly require each community platform entry to
link to its related GitHub issue or discussion, replacing the vague “GitHub
contribution” wording while preserving the contact and implementation-context
requirements.

Source: Path instructions

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/hcl.md`:
- Line 3: Rename the “Hardware Compatibility List” heading in docs/hcl.md or the
other identical heading so all Markdown section headings are unique and generate
unambiguous navigation anchors, while preserving the section’s meaning.

---

Outside diff comments:
In `@docs/hcl.md`:
- Around line 71-75: Update the “Coming Soon: Community-Added Platforms”
documentation to explicitly require each community platform entry to link to its
related GitHub issue or discussion, replacing the vague “GitHub contribution”
wording while preserving the contact and implementation-context requirements.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9c0d33ef-3053-49b3-8747-f27b15dac95e

📥 Commits

Reviewing files that changed from the base of the PR and between 45c94b2 and 01c1423.

📒 Files selected for processing (1)
  • docs/hcl.md

Comment thread docs/hcl.md
@@ -1,12 +1,18 @@
# Hardware Compatibility List

# Hardware Compatibility List

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Resolve the duplicate heading reported by MD024.

Rename this heading or the other identical heading so each section has a unique Markdown heading and unambiguous navigation anchor.

🧰 Tools
🪛 markdownlint-cli2 (0.23.0)

[warning] 3-3: Multiple headings with the same content

(MD024, no-duplicate-heading)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/hcl.md` at line 3, Rename the “Hardware Compatibility List” heading in
docs/hcl.md or the other identical heading so all Markdown section headings are
unique and generate unambiguous navigation anchors, while preserving the
section’s meaning.

Source: Linters/SAST tools

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