docs: clarify community hardware listings#3846
Conversation
Signed-off-by: Jared Conway <jaredc@nvidia.com>
|
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. |
Summary by CodeRabbit
WalkthroughThe 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. ChangesHardware support documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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>
|
🌿 Preview your docs: https://nvidia-preview-pull-request-3846.docs.buildwithfern.com/infra-controller |
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
docs/development/new_hardware_support.mddocs/hcl.md
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
left a comment
There was a problem hiding this comment.
Moved the date to the top for ya
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>
There was a problem hiding this comment.
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 winMake 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
📒 Files selected for processing (1)
docs/hcl.md
| @@ -1,12 +1,18 @@ | |||
| # Hardware Compatibility List | |||
|
|
|||
| # Hardware Compatibility List | |||
There was a problem hiding this comment.
📐 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
Description
Related issues
None.
Type of Change
Breaking Changes
Testing
Validated both edited Markdown files for trailing whitespace and unresolved relative links, and ran
git diff --check.