ROS: Reframe teleop_ros2 as the supported ROS 2 reference publisher

[sgrizan-nv]

Description

Clarify docs and package metadata so the node reads as a reference integration consumed by Isaac ROS Teleop, not a disposable example, without moving its path.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)
• Documentation update

Summary by CodeRabbit

• Documentation

  • Clarified that the ROS 2 teleoperation integration is a reference publisher rather than an example.
  • Improved setup guidance for configuration paths and package layout.
  • Updated integration test and retargeter descriptions for consistency.

• Build & Packaging

  • Updated project and package labels to identify the ROS 2 reference integration.
  • Clarified the build option description without changing its behavior.

[coderabbitai]

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: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: b1bddc65-9eee-4c66-a7c1-373de8d4dd34

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

📝 Walkthrough

Walkthrough

The change renames the ROS 2 integration’s CMake project and Python package metadata to reference-publisher terminology. Build option text, documentation, module descriptions, and parameter wording are updated accordingly. The Sharpa Wave URDF script now derives default directories from _tree_root() instead of _example_root(), without changing download or verification behavior.

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

🚥 Pre-merge checks | ✅ 4 | ❌ 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%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
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 accurately summarizes the main change: reclassifying teleop_ros2 as a supported ROS 2 reference publisher.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch sgrizan/branch1

---

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