docs: fix device registration handshake by favxlaw · Pull Request #822 · Project-HAMi/website

favxlaw · 2026-08-25T17:52:26Z

What type of PR is this? /kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes: Corrects the device registration handshake documentation to match the current implementation.

Fixes #

Checklist:

npm run lint and npm run format:check pass
npm run build succeeds for both en and zh
[] Chinese translation updated if English docs changed (or noted why not)
Commits are signed off (git commit -s)

Signed-off-by: favour.lawrence <favour.lawrence@moniepoint.com>

netlify · 2026-08-25T17:52:32Z

✅ Deploy Preview for project-hami ready!

Name	Link
🔨 Latest commit	`02718af`
🔍 Latest deploy log	https://app.netlify.com/projects/project-hami/deploys/6a8dd65d4d1b6f0008292d3c
😎 Deploy Preview	https://deploy-preview-822--project-hami.netlify.app
📱 Preview on mobile	Toggle 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.

coderabbitai · 2026-08-25T17:53:48Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 16a57d13-ac09-46e9-bbcf-70fa17f31c7f

📥 Commits

Reviewing files that changed from the base of the PR and between aaf4c7a and 02718af.

📒 Files selected for processing (1)

docs/developers/protocol.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

Walkthrough

The protocol documentation now describes patching device specifications into node annotations, removes the node-handshake registration entry, and changes the NVIDIA handshake status example from Reported to Requesting_.

Changes

Protocol documentation

Layer / File(s)	Summary
Registration and handshake examples `docs/developers/protocol.md`	The registration example omits `node-handshake`. The NVIDIA handshake example uses `Requesting_` status.

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

Merge Risk: ⚪ Minimal · up to 02718

This is a small, localized documentation correction with no actionable merge-blocking risk remaining after normal checks and review.

Suggested labels: kind/documentation

Suggested reviewers: archlitchi, wawa0210, mesutoezdil

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely describes the documentation changes that correct the device registration handshake details.

Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ 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.}

windsonsea

/approve

hami-robot · 2026-08-27T05:41:36Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: favxlaw, 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:

~~OWNERS~~ [windsonsea]

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

mesutoezdil · 2026-09-02T15:18:41Z


 ```text
-hami.io/node-handshake-nvidia: Reported 2024-01-23 04:30:04.434037031 +0000 UTC m=+1104711.777756895
+hami.io/node-handshake-nvidia: Requesting_2024-01-23 04:30:04.434037031 +0000 UTC m=+1104711.777756895


the Reported_ format line was removed above and this example now says Requesting_ too, so the page no longer shows the device plugin side of the handshake. is that intended?

mesutoezdil · 2026-09-02T15:18:42Z


 ```text
-hami.io/node-handshake-\{device-type\}: Reported_\{device_node_current_timestamp\}
 hami.io/node-\{device-type\}-register: \{Device 1\}:\{Device2\}:...:\{Device N\}


your pr #835 rewrites this same block to json. which of the two should land first?

mesutoezdil · 2026-09-02T16:07:55Z


 ```text
-hami.io/node-handshake-nvidia: Reported 2024-01-23 04:30:04.434037031 +0000 UTC m=+1104711.777756895
+hami.io/node-handshake-nvidia: Requesting_2024-01-23 04:30:04.434037031 +0000 UTC m=+1104711.777756895


pkg/device/nvidia/device.go sets HandshakeAnnos to the bare hami.io/node-handshake, only hygon and friends carry a suffix. so hami.io/node-handshake-nvidia does not exist. worth fixing in the same pass?

mesutoezdil · 2026-09-02T16:07:55Z

 <img src="/img/docs/common/developers/protocol/protocol-register.png" width="600px" alt="HAMi device registration protocol diagram showing node annotation process" />

-HAMi needs to know the spec of each AI device in the cluster to schedule properly. During device registration, device-plugin needs to keep patching the spec of each device into node annotations every 30 seconds, in the format of the following:
+HAMi needs to know the spec of each AI device in the cluster to schedule properly. During device registration, device-plugin needs to keep patching the spec of each device into a node annotation every 30 seconds, in the format of the following:


this now says a single node annotation, but the paragraph still describes the handshake plus the register key. does dropping the handshake line from the block above leave the sentence accurate?

docs: fix device registration handshake

02718af

Signed-off-by: favour.lawrence <favour.lawrence@moniepoint.com>

hami-robot Bot requested review from archlitchi and wawa0210 August 25, 2026 17:52

coderabbitai Bot added the kind/documentation Improvements or additions to documentation label Aug 25, 2026

github-actions Bot added the area/docs label Aug 25, 2026

windsonsea reviewed Aug 27, 2026

View reviewed changes

hami-robot Bot added the approved label Aug 27, 2026

mesutoezdil mentioned this pull request Sep 2, 2026

docs: update NVIDIA registration format #835

Open

4 tasks

mesutoezdil reviewed Sep 2, 2026

View reviewed changes

mesutoezdil mentioned this pull request Sep 2, 2026

docs(developers): add missing task dispatch section and diagram to protocol.md #811

Open

4 tasks

mesutoezdil reviewed Sep 2, 2026

View reviewed changes

rootsongjc mentioned this pull request Sep 3, 2026

Create v2.10.0 docs version (missing after release) #840

Open

3 tasks

Navigation Menu

Uh oh!

docs: fix device registration handshake - #822

docs: fix device registration handshake#822
favxlaw wants to merge 1 commit into
Project-HAMi:masterfrom
favxlaw:docs/fix-device-registration-handshake

favxlaw commented Aug 25, 2026 •

edited

Loading

Uh oh!

netlify Bot commented Aug 25, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 25, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

windsonsea left a comment

Uh oh!

hami-robot Bot commented Aug 27, 2026

Uh oh!

mesutoezdil Sep 2, 2026

Uh oh!

mesutoezdil Sep 2, 2026

Uh oh!

mesutoezdil Sep 2, 2026

Uh oh!

mesutoezdil Sep 2, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

favxlaw commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify Bot commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for project-hami ready!

Uh oh!

coderabbitai Bot commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

windsonsea left a comment

Choose a reason for hiding this comment

Uh oh!

hami-robot Bot commented Aug 27, 2026

Uh oh!

mesutoezdil Sep 2, 2026

Choose a reason for hiding this comment

Uh oh!

mesutoezdil Sep 2, 2026

Choose a reason for hiding this comment

Uh oh!

mesutoezdil Sep 2, 2026

Choose a reason for hiding this comment

Uh oh!

mesutoezdil Sep 2, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

favxlaw commented Aug 25, 2026 •

edited

Loading

netlify Bot commented Aug 25, 2026 •

edited

Loading

coderabbitai Bot commented Aug 25, 2026 •

edited

Loading