Skip to content

Update device sharing legend#566

Open
Shenhan11 wants to merge 1 commit into
Project-HAMi:masterfrom
Shenhan11:docs/update-image
Open

Update device sharing legend#566
Shenhan11 wants to merge 1 commit into
Project-HAMi:masterfrom
Shenhan11:docs/update-image

Conversation

@Shenhan11

@Shenhan11 Shenhan11 commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • Documentation
    • Updated Device Sharing documentation examples across current and versioned English and Chinese pages.
    • Replaced the embedded PNG example image with localized SVG illustrations for clearer, more consistent visuals.
    • Preserved existing captions, titles, and surrounding content.

@netlify

netlify Bot commented Jul 10, 2026

Copy link
Copy Markdown

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 9c33e2a
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/6a50a2e602fed30008d6b7cf
😎 Deploy Preview https://deploy-preview-566--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 mesutoezdil and rootsongjc July 10, 2026 07:26
@hami-robot hami-robot Bot added the size/XL label Jul 10, 2026
@coderabbitai

coderabbitai Bot commented Jul 10, 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: 915c7616-65d2-44cc-a699-895cc649c42d

📥 Commits

Reviewing files that changed from the base of the PR and between 2a6270c and 9c33e2a.

⛔ Files ignored due to path filters (4)
  • .codegraph/codegraph.db is excluded by !**/*.db
  • static/img/docs/common/key-features/example.png is excluded by !**/*.png
  • static/img/docs/en/key-features/example.svg is excluded by !**/*.svg
  • static/img/docs/zh/key-features/example.svg is excluded by !**/*.svg
📒 Files selected for processing (17)
  • docs/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/current/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v1.3.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.5.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.5.1/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.6.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.7.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/key-features/device-sharing.md
  • versioned_docs/version-v1.3.0/key-features/device-sharing.md
  • versioned_docs/version-v2.4.1/key-features/device-sharing.md
  • versioned_docs/version-v2.5.0/key-features/device-sharing.md
  • versioned_docs/version-v2.5.1/key-features/device-sharing.md
  • versioned_docs/version-v2.6.0/key-features/device-sharing.md
  • versioned_docs/version-v2.7.0/key-features/device-sharing.md
  • versioned_docs/version-v2.8.0/key-features/device-sharing.md
  • versioned_docs/version-v2.9.0/key-features/device-sharing.md
✅ Files skipped from review due to trivial changes (14)
  • docs/key-features/device-sharing.md
  • versioned_docs/version-v2.9.0/key-features/device-sharing.md
  • versioned_docs/version-v2.7.0/key-features/device-sharing.md
  • versioned_docs/version-v2.5.1/key-features/device-sharing.md
  • versioned_docs/version-v1.3.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v1.3.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.5.1/key-features/device-sharing.md
  • versioned_docs/version-v2.6.0/key-features/device-sharing.md
  • versioned_docs/version-v2.8.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.5.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.7.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/current/key-features/device-sharing.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.6.0/key-features/device-sharing.md

📝 Walkthrough

Walkthrough

Updated current and versioned English and Chinese device-sharing documentation pages to replace common PNG example images with localized SVG assets.

Changes

Device sharing documentation

Layer / File(s) Summary
Current documentation image references
docs/key-features/device-sharing.md, i18n/zh/docusaurus-plugin-content-docs/current/key-features/device-sharing.md
Current English and Chinese pages now reference SVG example assets instead of PNG assets.
Versioned documentation image references
i18n/zh/docusaurus-plugin-content-docs/version-.../key-features/device-sharing.md, versioned_docs/version-.../key-features/device-sharing.md
Versioned English and Chinese pages now reference language-specific SVG example assets instead of common PNG assets.

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

Suggested reviewers: mesutoezdil, archlitchi

Poem

A bunny hops through docs so bright,
Swapping PNGs for SVG light.
English paths and Chinese too,
New sharing scenes come hopping through.
Sniff, sniff—clean references bloom!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title mentions a legend, but the changes only update device-sharing documentation images from PNG to SVG. Rename it to reflect the docs image update, e.g. "Update device sharing docs image".
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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

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

Signed-off-by: Shenhan11 <han.shen@dynamia.ai>
Co-authored-by: Cursor <cursoragent@cursor.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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 `@versioned_docs/version-v2.4.1/key-features/device-sharing.md`:
- Line 10: Add exactly one trailing newline after the final content in the
device-sharing documentation file, without adding extra blank lines.

In `@versioned_docs/version-v2.5.0/key-features/device-sharing.md`:
- Line 10: Add exactly one trailing newline character at the end of the
device-sharing documentation file, after the final image reference.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 83fa5452-73df-4917-96c8-b8d8de4031bc

📥 Commits

Reviewing files that changed from the base of the PR and between aeb71db and 2a6270c.

⛔ Files ignored due to path filters (4)
  • .codegraph/codegraph.db is excluded by !**/*.db
  • static/img/docs/common/key-features/example.png is excluded by !**/*.png
  • static/img/docs/en/key-features/example.svg is excluded by !**/*.svg
  • static/img/docs/zh/key-features/example.svg is excluded by !**/*.svg
📒 Files selected for processing (17)
  • docs/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/current/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v1.3.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.5.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.5.1/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.6.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.7.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.8.0/key-features/device-sharing.md
  • i18n/zh/docusaurus-plugin-content-docs/version-v2.9.0/key-features/device-sharing.md
  • versioned_docs/version-v1.3.0/key-features/device-sharing.md
  • versioned_docs/version-v2.4.1/key-features/device-sharing.md
  • versioned_docs/version-v2.5.0/key-features/device-sharing.md
  • versioned_docs/version-v2.5.1/key-features/device-sharing.md
  • versioned_docs/version-v2.6.0/key-features/device-sharing.md
  • versioned_docs/version-v2.7.0/key-features/device-sharing.md
  • versioned_docs/version-v2.8.0/key-features/device-sharing.md
  • versioned_docs/version-v2.9.0/key-features/device-sharing.md

Comment thread versioned_docs/version-v2.4.1/key-features/device-sharing.md
Comment thread versioned_docs/version-v2.5.0/key-features/device-sharing.md

@rootsongjc rootsongjc left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

/lgtm

@hami-robot

hami-robot Bot commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rootsongjc, Shenhan11
Once this PR has been reviewed and has the lgtm label, please assign wawa0210 for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found 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

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.

2 participants