Add Haptikos documentation#642
Conversation
|
📝 Docs preview is not auto-deployed for fork PRs. A maintainer with write access to |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughThis PR adds documentation for Haptikos Exoskeletons as a supported input device for Isaac Teleop. It introduces a new comprehensive device guide covering integration, prerequisites, quick-start instructions, and licensing details. The documentation is cross-referenced throughout the project: added to the device plugin index and navigation, included in the ecosystem overview as a standalone device with manufacturer contact information, referenced in build project structure documentation, and explicitly mentioned in requirements documentation alongside other input devices like OAK-D. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~4 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsStopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 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 `@docs/source/device/haptikos.rst`:
- Line 31: Update the sentence in the Haptikos docs to correct spelling
mistakes: change "seperately" to "separately" and "licencing" to "licensing" in
the string that currently reads "The Haptikos API must be downloaded seperately
due to licencing. Check our `website <https://haptikos.tech/>`_." so the text
reads "The Haptikos API must be downloaded separately due to licensing. Check
our `website <https://haptikos.tech/>`_."
- Line 7: Change the pluralization in the sentence "Other headsets with
controller may work as well." to use "controllers" so it reads "Other headsets
with controllers may work as well."; locate that sentence in the Haptikos device
docs (the line containing "Other headsets with controller may work as well.")
and update the word "controller" to "controllers".
- Line 104: Fix the incomplete sentence about orientation calibration by
completing the thought and correcting "directional" to "direction";
specifically, update the sentence that starts with "The orientation calibration
defines the directional the Haptikos Gloves define as forward." to clarify that
the gloves' forward direction must be aligned with the Head Mounted Display's
forward orientation (or view direction), so rephrase to something like "The
orientation calibration defines the direction the Haptikos Gloves consider
forward, which must be aligned with the Head Mounted Display's forward/view
orientation." Ensure the corrected sentence replaces the original in the
haptikos.rst content.
- Line 68: Fix the typo in the CMake flag and the awkward phrase: change
"-DENABLE_CLANG_FORMAT_CHECH=OFF" to "-DENABLE_CLANG_FORMAT_CHECK=OFF" and
update "headers are HaptikosAPI library" to "headers in the HaptikosAPI library"
so the sentence reads correctly and the flag name is accurate.
- Line 108: Update the path string used in the sentence to match project
convention: replace the incorrect "/install/plugins/haptikos" with
"install/plugins/haptikos" in the haptikos documentation text so the line reads
"...the executable will also be found in the install/plugins/haptikos folder."
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 5c4c47e3-cdd3-4924-b18e-3ad4308d35cb
📒 Files selected for processing (5)
docs/source/device/haptikos.rstdocs/source/device/index.rstdocs/source/overview/ecosystem.rstdocs/source/references/build.rstdocs/source/references/requirements.rst
| Step 1: Get the Haptikos API | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The Haptikos API must be downloaded seperately due to licencing. Check our `website <https://haptikos.tech/>`_. |
There was a problem hiding this comment.
Fix spelling errors.
"seperately" should be "separately" and "licencing" should be "licensing".
📝 Proposed fix
-The Haptikos API must be downloaded seperately due to licencing. Check our `website <https://haptikos.tech/>`_.
+The Haptikos API must be downloaded separately due to licensing. Check our `website <https://haptikos.tech/>`_.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| The Haptikos API must be downloaded seperately due to licencing. Check our `website <https://haptikos.tech/>`_. | |
| The Haptikos API must be downloaded separately due to licensing. Check our `website <https://haptikos.tech/>`_. |
🤖 Prompt for 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.
In `@docs/source/device/haptikos.rst` at line 31, Update the sentence in the
Haptikos docs to correct spelling mistakes: change "seperately" to "separately"
and "licencing" to "licensing" in the string that currently reads "The Haptikos
API must be downloaded seperately due to licencing. Check our `website
<https://haptikos.tech/>`_." so the text reads "The Haptikos API must be
downloaded separately due to licensing. Check our `website
<https://haptikos.tech/>`_."
Source: Coding guidelines
PKonMagos
force-pushed
the
haptikos-docs-pr
branch
from
83dfbe3 to
21b2de5
Compare
|
/preview-docs |
|
❌ No successful |
| - | ||
| * - `Haptikos`_ | ||
| - Haptikos Exoskeletons | ||
| - |
There was a problem hiding this comment.
can you add some info about how to acquire your device?
jiwenc-nv
left a comment
jiwenc-nv
left a comment
There was a problem hiding this comment.
please fix pre-submit issues and address AI feedback.
PKonMagos
force-pushed
the
haptikos-docs-pr
branch
from
21b2de5 to
a6ef078
Compare
|
Greetings @jiwenc-nv , We have already added all the required links below. Also, I have restored the files and fixed the ai comments! |
|
@PKonMagos the pre-commits are failing. Can you follow the instructions in https://github.com/NVIDIA/IsaacTeleop/blob/main/CONTRIBUTING.md#pre-commit to help you address them correctly? Thanks. |
2 participants
Haptikos Documentation added to the current documentation
Summary by CodeRabbit