Skip to content

docs: update supported platform docs#207

Merged
jingxiang-z merged 1 commit into
mainfrom
docs/update-readme-docs-support
May 26, 2026
Merged

docs: update supported platform docs#207
jingxiang-z merged 1 commit into
mainfrom
docs/update-readme-docs-support

Conversation

@jingxiang-z
Copy link
Copy Markdown
Collaborator

@jingxiang-z jingxiang-z commented May 26, 2026

Summary

  • Update documented RAM usage guidance from <100MB to <500MB.
  • Add Ampere and Ada Lovelace to the supported GPU architecture lists, ordered before Hopper, Blackwell, and Rubin.
  • Add a bold warning that README documentation links point to main and release-specific installs should use docs from the matching release tag.

Validation

  • Reviewed the staged diff for README.md and docs/usage.md.
  • No tests run; documentation-only change.

Summary by CodeRabbit

  • Documentation
    • Updated resource guidance: target RAM threshold for "High resource usage" guidance changed from <100MB to <500MB.
    • Expanded supported GPU architectures in platform tables to include Ampere and Ada Lovelace alongside previously listed models.
    • Added an "Important" note clarifying linked documentation points to the main branch and may describe unreleased changes; recommend using documentation from the release tag matching your agent version.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

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: 293d94f5-ded1-4636-a860-8a6941bb154e

📥 Commits

Reviewing files that changed from the base of the PR and between 4dc5131 and 8e3e3a4.

📒 Files selected for processing (2)
  • README.md
  • docs/usage.md
✅ Files skipped from review due to trivial changes (2)
  • docs/usage.md
  • README.md

📝 Walkthrough

Walkthrough

This 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 main branch; usage docs mirror the GPU reorder and RAM threshold change.

Changes

Documentation Updates

Layer / File(s) Summary
README core edits
README.md
Removes the installation-prerequisites pointer; updates Key Features RAM claim to <500MB; expands Supported Platforms GPU lists to include Ampere and Ada Lovelace alongside existing families; adds an Important note that documentation links reference the main branch`.
Usage doc adjustments
docs/usage.md
Reorders the fleetint precheck supported GPU architecture checklist and raises the "High resource usage" RAM threshold from <100MB to <500MB, keeping other guidance unchanged.

🎯 2 (Simple) | ⏱️ ~10 minutes

🐰 I hopped through lines with care,
Tweaked RAM and GPUs, placed notes there,
Removed a pointer, reordered the list,
Docs now mention the main-branch twist,
A tiny hop — the README's kissed.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: update supported platform docs' accurately reflects the main changes, which focus on updating platform support documentation including GPU architectures and RAM requirements.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/update-readme-docs-support

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

@jingxiang-z jingxiang-z marked this pull request as ready for review May 26, 2026 20:36
@jingxiang-z jingxiang-z force-pushed the docs/update-readme-docs-support branch 2 times, most recently from 7048f48 to 4dc5131 Compare May 26, 2026 20:38
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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/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

📥 Commits

Reviewing files that changed from the base of the PR and between 58eacee and db2939c.

📒 Files selected for processing (2)
  • README.md
  • docs/usage.md

Comment thread docs/usage.md
Comment thread README.md
@jingxiang-z jingxiang-z requested a review from ebalduf May 26, 2026 20:39
Signed-off-by: Jingxiang Zhang <jingzhang@nvidia.com>
@jingxiang-z jingxiang-z force-pushed the docs/update-readme-docs-support branch from 4dc5131 to 8e3e3a4 Compare May 26, 2026 20:42
Copy link
Copy Markdown
Collaborator

@ebalduf ebalduf left a comment

Choose a reason for hiding this comment

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

This looks good to me.

@jingxiang-z jingxiang-z merged commit 0c37369 into main May 26, 2026
5 checks passed
@jingxiang-z jingxiang-z deleted the docs/update-readme-docs-support branch May 26, 2026 20:50
Comment thread README.md

## 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.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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:

@coderabbitai coderabbitai Bot mentioned this pull request May 28, 2026
3 tasks
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