Skip to content

docs: align Markdown documentation with Isaac Capture - #1261

Merged
jiwenc-nv merged 1 commit into
NVIDIA:mainfrom
jiwenc-nv:jiwenc-nv/isaac-capture-docs
Oct 14, 2026
Merged

jiwenc-nv merged 1 commit into
NVIDIA:mainfrom
jiwenc-nv:jiwenc-nv/isaac-capture-docs

Conversation

@jiwenc-nv

@jiwenc-nv jiwenc-nv commented Oct 13, 2026 •

Copy link
Copy Markdown
Collaborator

Introduce Isaac Capture as the overall library while retaining Isaac Teleop as its teleoperation component. Update the root README, shared project guidance, dependency/example indexes, code of conduct, and bug-report version label.

The README includes the supplied architecture diagram once, below the title and badges and above Overview, and links Isaac Lab 3.0.0 EA. Preserve technical identifiers and the approved example/plugin wording; exclude src/postprocessing/.

Validation: all-files pre-commit passed with SKIP=check-copyright-year; Markdown name variants rescanned and technical identifiers verified unchanged. The README changes also passed the strict docs build, Markdown rendering checks, and byte comparison of the supplied diagram.

@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-1261/

@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/IsaacCapture/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: 9dbba81c-1efd-4676-8f04-de93f7855c1a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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: 581bc7fb-071d-475e-8514-c6bef2a92aa3
📥 Commits

Reviewing files that changed from the base of the PR and between f3ade7c and 47b1ea7.

⛔ Files ignored due to path filters: 1
  • docs/source/_static/isaac-capture-architecture.png is excluded by !**/*.png
📒 Files selected for processing: 2
  • README.md
  • docs/source/_static/isaac-capture-architecture.png.license

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

The README now presents Isaac Capture as shared infrastructure for Isaac Teleop and Ego Pipeline. It adds an architecture image, separates teleoperation and egocentric use cases, and documents Ego Pipeline capture and post-processing. It updates the Isaac Lab reference to 3.0.0 EA. The architecture image license file adds SPDX copyright and Apache-2.0 metadata.

Priority: ⬇️ Low

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

Merge Risk: ⚪ Minimal · up to 47b1e

The README names Isaac Lab 3.0.0 EA, but the project does not pin a release and no concrete compatibility failure is established. No specific merge blocker is identified.

Pre-merge checks: Passed 5
Passed 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 identifies a documentation change and names Isaac Capture, which is the main focus of the pull request.
✨ 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.

@jiwenc-nv jiwenc-nv changed the title docs: introduce Isaac Capture in the root README docs: align Markdown documentation with Isaac Capture Oct 14, 2026
Present Isaac Capture as the shared library while retaining Isaac Teleop as its teleoperation component. Include the architecture diagram and updated Isaac Lab reference, and align shared project guidance with the umbrella name.

Signed-off-by: Jiwen Cai <jiwenc@nvidia.com>
@jiwenc-nv
jiwenc-nv force-pushed the jiwenc-nv/isaac-capture-docs branch from 837d07d to 83449f0 Compare October 14, 2026 02:21
@jiwenc-nv
jiwenc-nv merged commit e4b222c into NVIDIA:main Oct 14, 2026
32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants