Skip to content

feat: improved docs for new hardware support#3282

Open
krish-nvidia wants to merge 3 commits into
NVIDIA:mainfrom
krish-nvidia:improved-new-hardware-docs
Open

feat: improved docs for new hardware support#3282
krish-nvidia wants to merge 3 commits into
NVIDIA:mainfrom
krish-nvidia:improved-new-hardware-docs

Conversation

@krish-nvidia

Copy link
Copy Markdown
Contributor

This PR improves the new hardware support guide by documenting:

  • Upstream libredfish and nv-redfish contribution flow
  • Live-BMC testing with bmc-explorer-cli and nico-admin-cli
  • Optional BMC mock coverage
  • HCL, dependency update, and PR evidence requirements
  • nv-redfish as the default exploration path

Related issues

#3281

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

  • Unit tests added/updated
  • Integration tests added/updated
  • Manual testing performed
  • No testing required (docs, internal refactor, etc.)

Additional Notes

Signed-off-by: Krish Dandiwala <kdandiwala@nvidia.com>
@krish-nvidia krish-nvidia requested a review from poroh July 8, 2026 20:55
@krish-nvidia krish-nvidia self-assigned this Jul 8, 2026
@krish-nvidia krish-nvidia requested a review from polarweasel as a code owner July 8, 2026 20:56
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 9f36f776-18ab-4c9d-bf21-d7473bf9678c

📥 Commits

Reviewing files that changed from the base of the PR and between f25c7d5 and 2218a35.

📒 Files selected for processing (1)
  • docs/development/new_hardware_support.md
✅ Files skipped from review due to trivial changes (1)
  • docs/development/new_hardware_support.md

Summary by CodeRabbit

  • Documentation
    • Expanded and reorganized the “Adding Support for New Hardware” guide with clearer structure and stronger contribution constraints.
    • Clarified scope, evidence capture expectations, and guardrails to avoid breaking existing platforms.
    • Improved explanation of the end-to-end Redfish exploration flow and how exploration modes affect coverage.
    • Updated scenarios for new vendors, new server models with quirks, and firmware updates with more concrete remediation steps.
    • Reworked testing instructions with specific validation targets and example command sequences.
    • Added code-structure reference material, guidance for adding quirks/mock coverage, and contribution checklist updates.

Walkthrough

The hardware support guide is reorganized with updated startup guidance, revised scenario instructions, expanded testing procedures, and new reference and contribution sections for new hardware work.

Changes

Hardware Support Guide Update

Layer / File(s) Summary
Prerequisites, overview, and coordination
docs/development/new_hardware_support.md
Adds the no-regression constraint, rewrites the opening guidance and Redfish overview, and updates the Redfish library coordination steps.
Scenario guidance updates
docs/development/new_hardware_support.md
Refines Scenario 1, Scenario 2, and Scenario 3 with vendor detection, OEM model types, config-driven profile handling, and concrete endpoint comparison and remediation steps.
BMCVendor mapping guidance
docs/development/new_hardware_support.md
Updates the vendor mapping guidance to point at the libredfish-to-NICo conversion path and related parsing conversions.
Explorer and admin validation
docs/development/new_hardware_support.md
Reworks the BMC Explorer and nico-admin-cli validation instructions with concrete build steps, report checks, local dependency overrides, and command-by-command live validation.
Code structure and contribution workflow
docs/development/new_hardware_support.md
Extends the guide with code structure references, nv-redfish quirk guidance, optional BMC mock coverage, and detailed contribution workflow requirements.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and clearly describes the documentation update for new hardware support.
Description check ✅ Passed The description is directly aligned with the documented hardware support guide updates.
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.

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

🔍 Container Scan Summary

No Grype artifacts were found to aggregate.

@github-actions

github-actions Bot commented Jul 8, 2026

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`:
- Around line 128-130: The guidance should point to the real cross-crate mapping
hook instead of a nonexistent `From<RedfishVendor>` impl. Update the docs to
reference `bmc_vendor(...)` in `crates/redfish/src/libredfish/conv.rs` as the
extension point for wiring libredfish vendor detection into `BMCVendor`, and
keep the other enum/string parsing mentions aligned with that actual conversion
path.
- Around line 311-314: The markdown link in the “Testing with nico-admin-cli
redfish” reference is split awkwardly between the link label and the inline code
text, so update the affected sentence in the lifecycle validation list to make
the entire section name part of a single link. Keep the existing anchor target,
but rewrite the reference near the “Complete the live-BMC validation…” item so
the full “Testing with nico-admin-cli redfish” text is rendered as one clickable
link.
🪄 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: 7ba040eb-a0bf-48b2-ba26-1f28dd0ea4e7

📥 Commits

Reviewing files that changed from the base of the PR and between 1287fdb and 56f9a44.

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

Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md Outdated
Signed-off-by: Krish Dandiwala <kdandiwala@nvidia.com>
Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md
Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md Outdated
Comment thread docs/development/new_hardware_support.md Outdated
Signed-off-by: Krish Dandiwala <kdandiwala@nvidia.com>
@krish-nvidia krish-nvidia requested a review from polarweasel July 9, 2026 14:10
@krish-nvidia krish-nvidia enabled auto-merge (squash) July 9, 2026 16:29
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.

3 participants