docs: fix awsneuron link typo and gpumem memory-unit comment - #605
Conversation
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughDocumentation examples now describe NVIDIA GPU memory as MiB, and the AWS Neuron instructions use the corrected “Neuron Device Plugin” link text in English and Chinese documentation. ChangesDocumentation terminology corrections
Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
@coderabbitai review |
✅ Action performedReview finished.
|
ad648d7 to
601d33a
Compare
- fix link text 'Neuro Device Plugin' -> 'Neuron Device Plugin' (the URL anchor and surrounding text both use neuron-device-plugin) - clarify the gpumem comment '3000m' -> '3000 MiB' (the doc states each unit of nvidia.com/gpumem equals 1 MiB, so 3000 units = 3000 MiB) Signed-off-by: wangmin <wangmin@riseunion.io>
601d33a to
707277a
Compare
|
/lgtm |
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Wangmin362, windsonsea The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
What this PR does / why we need it
Two small correctness fixes:
awsneuron-device/enable-awsneuron-managing.md) — the link text readsNeuro Device Plugin; it should beNeuron Device Plugin. The link's own URL anchor is#neuron-device-pluginand the same sentence refers toneuron-device-pluginonneuronnodes.gpumemmemory-unit comment (nvidia-device/specify-device-memory-usage.md,key-features/device-resource-isolation.md) — the comment says3000m device memory.mis the Kubernetes milli suffix, which is misleading here. The doc itself states "each unit ofnvidia.com/gpumemequals 1 MiB", sonvidia.com/gpumem: 3000is3000 MiB(the nearby text also says "will see 3G device memory"). Changed the comment to3000 MiB.Both the
docs/version and thei18n/zhmirror are updated.Verification
npm run check:all(markdownlint + prettier + build + linkinator) passes locally.AI assistance
Drafted with AI assistance (Claude Code) and reviewed and verified by me.
Summary by CodeRabbit