Repository navigation
docs: organize RST guides around Isaac Capture - #1265
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 configuration
You can disable this status message by setting the Use the checkbox below for a quick retry:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📝 Walkthrough
Merge Risk: ⚪ Minimal · up to
|
| Check name | Status | Explanation | Resolution |
|---|---|---|---|
| Docstring Coverage |  |
Docstring coverage is 75.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 2 files. (72 skipped: … | Write docstrings for the functions missing them to satisfy the coverage threshold. |
-
Check name Status Explanation Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Description Check Check skipped - CodeRabbit’s high-level summary is enabled. Title check The title clearly summarizes the primary change: reorganizing the RST guides around Isaac Capture.
Full details: Docstring Coverage
-
Explanation
Docstring coverage is 75.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 4 functions across 2 files. (72 skipped: 72 unsupported.)
✨ Finishing Touches: 💡 1
-
⚔️ Resolve merge conflicts: 💡
-
- Resolve merge conflict in branch
jiwenc/isaac-capture-rst
- Resolve merge conflict in branch
🧪 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.
|
/preview-docs |
|
❌ No successful |
9ae70d2 to
c1f371d
Compare
|
/preview-docs |
|
✅ Preview deployed: https://NVIDIA.github.io/IsaacCapture/preview/pr-1265/ |
Present Isaac Capture as the shared library while retaining Isaac Teleop as its teleoperation component. Move guides into the approved sections, preserve old URLs with compatibility pages, and keep versioned ecosystem links tied to their source ref. Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
c1f371d to
ae4c898
Compare
|
/preview-docs |
|
✅ Preview deployed: https://NVIDIA.github.io/IsaacCapture/preview/pr-1265/ |
ivany-nv
left a comment
ivany-nv
left a comment
There was a problem hiding this comment.
Summary
This moves 26 guides into teleop/, development/ and device-category folders behind :orphan: stubs, rebrands the landing and architecture pages, and loads devices.yaml from app.srcdir so each version links its own docnames. CI is green, and my own checks agreed: strict make current-docs, a sphinx-multiversion build of release/1.5.x–1.7.x and v1.5.175 with this config, and a merge with main resolved by adding device/gamepad all pass. Every moved page differs from its original only by path fixes and the umbrella rename. Nothing blocks; the points below are about what readers land on and where the next device page goes.
Legend: 🚫 BLOCKER = merge-blocking | 💡 SUGGESTION = meaningful improvement | 🧹 NIT = precise small correction
| Finding | |
|---|---|
| 🚫 | none |
| 💡 | docs/source/device/manus.rst:4 - All 26 stubs are indexed by site search under the same title as their destination, so "MANUS Gloves", "Quick Start" or "Teleop Session" each return two hits, one of them a "This page has moved" page. They also don't forward, and search engines will index them. The site already handles a moved page with refresh + noindex + canonical (gh-pages 753db20). Adding :nosearch: plus a .. meta:: block with :http-equiv=refresh: and :robots: noindex to each stub fixes both without JavaScript; verified on this stub under make current-docs. |
| 💡 | docs/source/overview/architecture.rst:11 - The figure is a redrawn SVG whose labels differ from the supplied diagram that #1261 merged as _static/isaac-capture-architecture.png for the README: "Core" became "Shared infrastructure", "Data Utils" became "Data utilities", "Ego Post Processing" became "Ego Post-Processing", and the retargeter line changed. Plan row R02 is "Align supplied component diagram", and two versions of one diagram will drift. After rebasing, use the PNG (or an SVG regenerated from it) and keep one asset. |
| 💡 | docs/AGENTS.md:40 - "Device pages stand alone" still says docs/source/device/*.rst is what the site renders, which after this PR matches mostly the compatibility stubs, and the new "RST restructuring" section doesn't say which folder a new device page goes in. main already added device/gamepad.rst flat (the source of the index.rst conflict), and #1153, #1077 and #1071 add more flat pages. |
| 🧹 | docs/source/overview/architecture.rst:25-26 - "Ego Post-Processing" doesn't match "Ego Post Processing" in the supplied diagram, the README and the naming doc. Neither this paragraph nor index.rst:19 links anywhere, while the README sends that name to references/egocentric_hand_reconstruction. |
| 🧹 | README.md:57-58 - Non-docs files still link to moved pages: the README's install and build links, scripts/run_cloudxr.sh:14-15, the deprecation warning in src/compat/isaacteleop.py:30, and the Haptikos, Wuji and haptic-feedback example READMEs. They resolve, but to stubs. Released 1.6 wheels print the references/migration URL, so that stub has to stay either way. |
Actionables (copy-paste-ready for implementation agents)
Validate these suggestions in context before applying them. Skip anything already addressed, incorrect, or not worth the churn.
docs/source/{device,getting_started,references}/**compatibility stubs - Add:nosearch:after:orphan:and a.. meta::block with:http-equiv=refresh: 0; url=<relative new page>.htmland:robots: noindex.docs/source/overview/architecture.rst:11- After rebasing ontomain, reference/_static/isaac-capture-architecture.png(or an SVG regenerated from it) and deleteisaac-capture-architecture.svg.docs/AGENTS.md:40- Changedocs/source/device/*.rsttodocs/source/device/**/*.rstand name the category folders new device pages belong in.docs/source/index.rst- Resolve themainconflict by adding Gamepad to the Devices toctree, moved into a category folder with itsdevices.yamldoc:updated.docs/source/overview/architecture.rst:26- Spell the stage "Ego Post Processing" and link/references/egocentric_hand_reconstruction; link it fromdocs/source/index.rst:19-20too.README.md,scripts/run_cloudxr.sh:14-15,src/compat/isaacteleop.py:7,30,src/plugins/haptikos/README.md:66,src/plugins/wuji_glove/README.md:13,examples/haptic_feedback/python/README.md:26- Point docs links at the new page paths.
Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
|
/preview-docs |
|
✅ Preview deployed: https://NVIDIA.github.io/IsaacCapture/preview/pr-1265/ |
Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
|
/preview-docs |
|
✅ Preview deployed: https://NVIDIA.github.io/IsaacCapture/preview/pr-1265/ |
2 participants
Description
Reorganize the RST documentation around Isaac Capture as the shared library and Isaac Teleop as its teleoperation component. Move 26 guides into Teleop, Development, Integrations, and device-category folders, retaining compatibility pages at the old URLs and all explicit labels. LeRobot workflows live under Integrations.
Add a Capture homepage, Teleop overview, the shared README architecture image, and integration placeholders. Group device guides under category pages and preserve the requirements and reconstruction reference pages. Deferred vendor write-ups remain out of scope. Resolve ecosystem metadata from the ref being built to preserve older-version links.
Type of change
Testing
SKIP=check-copyright-year.No new tests: documentation builds and structural checks validate this change.
Checklist
Summary by CodeRabbit