Skip to content

docs: fix awsneuron link typo and gpumem memory-unit comment - #605

Merged
hami-robot[bot] merged 1 commit into
Project-HAMi:masterfrom
Wangmin362:pr-d-links-typos
Jul 14, 2026
Merged

docs: fix awsneuron link typo and gpumem memory-unit comment#605
hami-robot[bot] merged 1 commit into
Project-HAMi:masterfrom
Wangmin362:pr-d-links-typos

Conversation

@Wangmin362

@Wangmin362 Wangmin362 commented Jul 13, 2026

Copy link
Copy Markdown
Member

What this PR does / why we need it

Two small correctness fixes:

  • AWS Neuron link typo (awsneuron-device/enable-awsneuron-managing.md) — the link text reads Neuro Device Plugin; it should be Neuron Device Plugin. The link's own URL anchor is #neuron-device-plugin and the same sentence refers to neuron-device-plugin on neuron nodes.
  • gpumem memory-unit comment (nvidia-device/specify-device-memory-usage.md, key-features/device-resource-isolation.md) — the comment says 3000m device memory. m is the Kubernetes milli suffix, which is misleading here. The doc itself states "each unit of nvidia.com/gpumem equals 1 MiB", so nvidia.com/gpumem: 3000 is 3000 MiB (the nearby text also says "will see 3G device memory"). Changed the comment to 3000 MiB.

Both the docs/ version and the i18n/zh mirror 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

  • Documentation
    • Clarified NVIDIA GPU memory examples to consistently specify values in MiB.
    • Corrected the AWS Neuron plugin name in the setup instructions.
    • Updated equivalent Chinese documentation for clearer device memory guidance.

@netlify

netlify Bot commented Jul 13, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 707277a
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a558dd07f624b0008e93087
😎 Deploy Preview https://deploy-preview-605--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@hami-robot
hami-robot Bot requested review from archlitchi and mesutoezdil July 13, 2026 03:28
@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 447cc4a6-5fa5-4d48-8ab3-277eaca2b174

📥 Commits

Reviewing files that changed from the base of the PR and between b1a6427 and 707277a.

📒 Files selected for processing (5)
  • docs/key-features/device-resource-isolation.md
  • docs/userguide/awsneuron-device/enable-awsneuron-managing.md
  • docs/userguide/nvidia-device/specify-device-memory-usage.md
  • i18n/zh/docusaurus-plugin-content-docs/current/key-features/device-resource-isolation.md
  • i18n/zh/docusaurus-plugin-content-docs/current/userguide/nvidia-device/specify-device-memory-usage.md

📝 Walkthrough

Walkthrough

Documentation 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.

Changes

Documentation terminology corrections

Layer / File(s) Summary
Update documentation terminology
docs/key-features/..., docs/userguide/nvidia-device/..., docs/userguide/awsneuron-device/..., i18n/zh/...
NVIDIA GPU memory comments use 3000 MiB, and the AWS plugin reference is corrected from “Neuro Device Plugin” to “Neuron Device Plugin”.

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

Suggested reviewers: archlitchi, rootsongjc, mesutoezdil, shenhan11, windsonsea

Poem

A rabbit hops through docs so bright,
Fixing MiB from morn till night.
“Neuron” now is spelled just right,
Clean examples shine in light.
- =^.^=//

🚥 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 clearly summarizes the two documentation fixes: the AWS Neuron link text typo and the gpumem unit comment correction.
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

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.

❤️ Share

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

@hami-robot hami-robot Bot added the size/XS label Jul 13, 2026
@Wangmin362

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Comment thread docs/key-features/device-resource-isolation.md
Comment thread docs/userguide/nvidia-device/specify-device-memory-usage.md
- 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>
@hami-robot hami-robot Bot added size/S and removed size/XS labels Jul 14, 2026
@mesutoezdil

Copy link
Copy Markdown
Contributor

/lgtm

@windsonsea

Copy link
Copy Markdown
Member

/approve

@hami-robot

hami-robot Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

[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

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@hami-robot hami-robot Bot added the approved label Jul 14, 2026
@hami-robot
hami-robot Bot merged commit 8aa7d02 into Project-HAMi:master Jul 14, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants