Skip to content

docs(sharpa): use AvatarExo product name - #1244

Merged
lotusl-code merged 1 commit into
NVIDIA:mainfrom
zihanjiang321:codex/rename-avatar-exo-main
Oct 13, 2026
Merged

lotusl-code merged 1 commit into
NVIDIA:mainfrom
zihanjiang321:codex/rename-avatar-exo-main

Conversation

@zihanjiang321

@zihanjiang321 zihanjiang321 commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Description

Update user-facing Sharpa glove naming to use the official product name Sharpa AvatarExo Glove, with Sharpa AE Glove as the shorter form where appropriate.

This PR only updates product naming. No behavior, APIs, or internal identifiers are changed.

Type of change

  • Documentation update

Summary by CodeRabbit

  • Documentation
    • Updated plugin, glove, and example descriptions to use the Sharpa AvatarExo and Sharpa AE names.
    • Clarified that the gloves connect through a USB dongle or USB cable.
    • Runtime behavior and configuration instructions are unchanged.

Signed-off-by: zihan <zihan.jiang@sharpa.com>
@github-actions

Copy link
Copy Markdown
Contributor

📝 Docs preview is not auto-deployed for fork PRs.

A maintainer with write access to NVIDIA/IsaacCapture can deploy a preview by
commenting /preview-docs on this PR. Once deployed, the preview
will live at:

https://nvidia.github.io/IsaacCapture/preview/pr-1244/

@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/IsaacCapture/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: e43d6df2-8315-4147-ba48-3f5715a25437

📥 Commits

Reviewing files that changed from the base of the PR and between 9aee765 and 25681cc.


📒 Files selected for processing (8)
  • CMakeLists.txt
  • docs/source/device/sharpa_avatar.rst
  • examples/sharpa_avatar/README.md
  • examples/sharpa_avatar/pyproject.toml
  • examples/sharpa_avatar/python/isaaccapture_examples/sharpa_avatar/live_view.py
  • src/plugins/sharpa_avatar/README.md
  • src/plugins/sharpa_avatar/install_udev_rules.sh
  • src/plugins/sharpa_avatar/plugin.yaml.in

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.



📝 Walkthrough

Walkthrough

The pull request updates Sharpa Avatar references to Sharpa AvatarExo or Sharpa AE in build and plugin descriptions, tracker descriptions, installation messages, documentation, and the example. The plugin remains disabled by default, and the example’s runtime logic remains unchanged. The plugin README now lists USB cable as an alternative connection method to a USB dongle.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes


Merge Risk: ⚪ Minimal · up to 25681

The changes update product naming and connection guidance. Available product information supports the USB options, and no concrete merge-blocking risk is established.

Pre-merge checks | Passed 4 | Failed 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (6 skipped: 6 … Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes the main change: updating Sharpa documentation and user-facing text to use the AvatarExo product name.
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.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (6 skipped: 6 unsupported.)


  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@lotusl-code
lotusl-code enabled auto-merge (squash) October 13, 2026 22:37
@lotusl-code
lotusl-code merged commit 1641ca8 into NVIDIA:main Oct 13, 2026
34 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