docs: update supported platform docs#207
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughThis PR updates docs: README removes a setup pointer, changes Key Features RAM from <100MB to <500MB, expands/reorders supported GPU lists to include Ampere and Ada Lovelace, and adds a note that linked docs target the ChangesDocumentation Updates
🎯 2 (Simple) | ⏱️ ~10 minutes
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
7048f48 to
4dc5131
Compare
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/usage.md`:
- Line 95: The documented list of supported GPU architectures in docs/usage.md
is out of order compared to the implementation in internal/precheck/precheck.go
(which enumerates Hopper, Blackwell, Rubin, Ampere, Ada Lovelace); update the
docs entry for the `fleetint precheck` architecture list to match the source
order exactly (Hopper, Blackwell, Rubin, Ampere, Ada Lovelace) so documentation
and the `fleetint precheck` behavior/messages remain consistent.
In `@README.md`:
- Around line 31-35: The README GPU architecture list order mismatches the
source order from internal/precheck/precheck.go; update either the README table
or the architectures slice in precheck.go so both present the same ordering.
Locate the architectures source in precheck.go (the slice or function that
returns supported architectures, e.g., the supportedArchitectures variable /
getSupportedArchitectures function) and reorder its entries to match the README
(Ampere, Ada Lovelace, Hopper, Blackwell, Rubin) or vice versa—then run the
CLI/precheck to confirm the displayed order matches the README.
🪄 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: c2186d7b-9897-4390-a52c-c5c38e1f8277
📒 Files selected for processing (2)
README.mddocs/usage.md
Signed-off-by: Jingxiang Zhang <jingzhang@nvidia.com>
4dc5131 to
8e3e3a4
Compare
|
|
||
| ## Documentation | ||
|
|
||
| **Important:** Documentation links are relative to the branch or tag you are viewing. The default GitHub view uses `main`, which may describe unreleased changes. When installing or upgrading a specific agent version, switch to that version's release tag first. |
There was a problem hiding this comment.
which may describe new features not present in existing releases. Please refer to the appropriate version's release tag to view documentation for that release. You can find the agent version by running:
Summary
<100MBto<500MB.mainand release-specific installs should use docs from the matching release tag.Validation
README.mdanddocs/usage.md.Summary by CodeRabbit