Skip to content

Commit 5d640d4

Browse files
committed
Address comments
1 parent bf5bab8 commit 5d640d4

10 files changed

Lines changed: 19 additions & 19 deletions

File tree

benchmark/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Performance benchmarks for comparing ROS 2 client libraries: C++ (rclcpp), Pytho
44

55
## Prerequisites
66

7-
1. **ROS 2**: Install from [ros.org](https://docs.ros.org/en/jazzy/Installation.html)
7+
1. **ROS 2**: Install from [ros.org](https://docs.ros.org/en/lyrical/Installation.html)
88
2. **Node.js**: v20.20.2+ for rclnodejs (from [nodejs.org](https://nodejs.org/))
99
3. **rclnodejs**: Follow [installation guide](https://github.com/RobotWebTools/rclnodejs#installation)
1010
4. **Build Dependencies**: For C++ benchmarks: `sudo apt install libssl-dev cmake build-essential`

demo/electron/car/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ This demo showcases how to use **rclnodejs** with **Electron** to create an inte
2929

3030
Before running this demo, ensure you have:
3131

32-
1. **ROS2 installed** (Humble, Jazzy, Kilted, or Rolling)
32+
1. **ROS2 installed** (Humble, Jazzy, Kilted, Lyrical, or Rolling)
3333
2. **Node.js** (version 20.20.2 or higher)
3434
3. **rclnodejs built** and working
3535

@@ -319,9 +319,9 @@ console.log('Publishing command:', command, twist);
319319
## 📚 Learning Resources
320320

321321
- [rclnodejs Documentation](https://github.com/RobotWebTools/rclnodejs)
322-
- [ROS2 Tutorials](https://docs.ros.org/en/rolling/Tutorials.html)
322+
- [ROS2 Tutorials](https://docs.ros.org/en/lyrical/Tutorials.html)
323323
- [Electron Documentation](https://www.electronjs.org/docs)
324-
- [geometry_msgs/Twist Documentation](https://docs.ros.org/en/rolling/p/geometry_msgs/interfaces/msg/Twist.html)
324+
- [geometry_msgs/Twist Documentation](https://docs.ros.org/en/lyrical/p/geometry_msgs/interfaces/msg/Twist.html)
325325

326326
## 📄 License
327327

demo/electron/manipulator/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ An interactive Electron application demonstrating a two-joint robotic manipulato
1717
## 📋 Prerequisites
1818

1919
- **Node.js** (>= 20.20.2) - JavaScript runtime
20-
- **ROS 2** (Humble, Jazzy, or newer) - Robot Operating System 2
20+
- **ROS 2** (Humble, Jazzy, Kilted, Lyrical, or Rolling) - Robot Operating System 2
2121
- **rclnodejs compatible environment** - Linux recommended (tested on Ubuntu/WSL)
2222

2323
## 🛠️ Installation
@@ -329,7 +329,7 @@ manipulator/
329329

330330
## 📚 Learning Resources
331331

332-
- **ROS2 Concepts**: [ROS2 Documentation](https://docs.ros.org/en/humble/)
332+
- **ROS2 Concepts**: [ROS2 Documentation](https://docs.ros.org/en/lyrical/)
333333
- **Three.js Guide**: [Three.js Documentation](https://threejs.org/docs/)
334334
- **Electron Tutorials**: [Electron Documentation](https://electronjs.org/docs)
335335
- **rclnodejs API**: [rclnodejs Repository](https://github.com/RobotWebTools/rclnodejs)

demo/electron/topics/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ A minimal Electron application demonstrating basic ROS2 topic communication usin
2222
## 📋 Prerequisites
2323

2424
- **Node.js** (>= 20.20.2) - JavaScript runtime
25-
- **ROS 2** (Humble, Jazzy, or newer) - Robot Operating System 2
25+
- **ROS 2** (Humble, Jazzy, Kilted, Lyrical, or Rolling) - Robot Operating System 2
2626
- **rclnodejs compatible environment** - Linux recommended (tested on Ubuntu/WSL)
2727

2828
## 🛠️ Installation

demo/electron/turtle_tf2/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The turtle_tf2 demo showcases:
5050

5151
### System Requirements
5252

53-
- **ROS2**: Humble, Iron, or Rolling distribution
53+
- **ROS2**: Humble, Jazzy, Kilted, Lyrical, or Rolling distribution
5454
- **Node.js**: Version 20.20.2 or higher
5555
- **turtlesim**: ROS2 turtle simulation package
5656
- **Electron**: For desktop application framework
@@ -404,7 +404,7 @@ turtle_tf2/
404404

405405
## Related Resources
406406

407-
- [ROS2 TF2 Tutorials](https://docs.ros.org/en/humble/Tutorials/Intermediate/Tf2/Tf2-Main.html)
407+
- [ROS2 TF2 Tutorials](https://docs.ros.org/en/lyrical/Tutorials/Intermediate/Tf2/Tf2-Main.html)
408408
- [turtle_tf2_py Source](https://github.com/ros/geometry_tutorials/tree/ros2/turtle_tf2_py)
409409
- [Three.js Documentation](https://threejs.org/docs/)
410410
- [rclnodejs GitHub](https://github.com/RobotWebTools/rclnodejs)

demo/typescript/actions/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ demo/typescript/actions/
4848

4949
Before running this demo, ensure you have:
5050

51-
1. **ROS2** installed (tested with ROS2 Humble/Iron/Jazzy)
51+
1. **ROS2** installed (tested with ROS2 Humble/Jazzy/Kilted/Lyrical)
5252
2. **Node.js** (version 20.20.2 or higher)
5353
3. **rclnodejs** built and configured in the parent directory (`../../`)
5454
4. **test_msgs** package available (usually included with ROS2)

docs/BUILDING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
### Get ready for ROS 2
44

5-
1.Install ROS 2 from binary package.
5+
1. Install ROS 2 from binary package.
66

7-
ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2. You can download the latest binary packages from [ROS 2 build farm](http://ci.ros2.org/view/packaging/) and follow the instructions of [Linux](https://docs.ros.org/en/rolling/Installation/Ubuntu-Install-Debians.html)/[Windows](https://docs.ros.org/en/rolling/Installation/Windows-Install-Binary.html) to setup the environment. Supported ROS 2 distributions: Rolling, Lyrical, Kilted, Jazzy, and Humble.
7+
ROS 2 is a cross-platform system, which covers Linux, macOS and Windows, and the `rclnodejs` module is developed against the [`master`](https://github.com/ros2/ros2/blob/master/ros2.repos) branch of ROS 2. You can download the latest binary packages from the [ROS 2 nightly builds](https://github.com/ros2/ros2/releases/tag/release-rolling-nightlies) and follow the instructions of [Linux](https://docs.ros.org/en/lyrical/Installation/Ubuntu-Install-Debians.html)/[Windows](https://docs.ros.org/en/lyrical/Installation/Windows-Install-Binary.html) to setup the environment. Supported ROS 2 distributions: Rolling, Lyrical, Kilted, Jazzy, and Humble.
88

9-
2.Build ROS 2 from scratch.
9+
2. Build ROS 2 from scratch.
1010

11-
Alternatively, you can build ROS 2 from scratch. Please select the platform you want to work on, then reference the instructions of [Linux](https://docs.ros.org/en/rolling/Installation/Alternatives/Ubuntu-Development-Setup.html#)/[Windows](https://docs.ros.org/en/rolling/Installation/Alternatives/Windows-Development-Setup.html) to build ROS 2 (please build with flag `--merge-install`).
11+
Alternatively, you can build ROS 2 from scratch. Please select the platform you want to work on, then reference the instructions of [Linux](https://docs.ros.org/en/lyrical/Installation/Alternatives/Ubuntu-Development-Setup.html#)/[Windows](https://docs.ros.org/en/lyrical/Installation/Alternatives/Windows-Development-Setup.html) to build ROS 2 (please build with flag `--merge-install`).
1212

1313
### Install `Node.js`
1414

tutorials/content-filtering-subscription.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -164,8 +164,8 @@ const isSupported =
164164

165165
## References
166166

167-
- [ROS 2 Content Filtering Documentation](https://docs.ros.org/en/kilted/Tutorials/Demos/Content-Filtering-Subscription.html)
168-
- [Advanced Topic Keys Tutorial](https://docs.ros.org/en/kilted/Tutorials/Advanced/Topic-Keys/Filtered-Topic-Keys-Tutorial.html)
167+
- [ROS 2 Content Filtering Documentation](https://docs.ros.org/en/lyrical/Tutorials/Demos/Content-Filtering-Subscription.html)
168+
- [Advanced Topic Keys Tutorial](https://docs.ros.org/en/lyrical/Tutorials/Advanced/Topic-Keys/Filtered-Topic-Keys-Tutorial.html)
169169
- [rclnodejs GitHub Repository](https://github.com/RobotWebTools/rclnodejs)
170170

171171
---
@@ -488,7 +488,7 @@ Content filtering in rclnodejs provides powerful message filtering at the DDS mi
488488

489489
For more information:
490490

491-
- [ROS 2 Content Filtering Demo](https://docs.ros.org/en/kilted/Tutorials/Demos/Content-Filtering-Subscription.html)
491+
- [ROS 2 Content Filtering Demo](https://docs.ros.org/en/lyrical/Tutorials/Demos/Content-Filtering-Subscription.html)
492492
- [rclnodejs API Documentation](https://robotwebtools.github.io/rclnodejs/)
493493
- [Content filtering tests](../test/test-subscription-content-filter.js)
494494
- [DDS 1.4 Specification](https://www.omg.org/spec/DDS/1.4/PDF) (Annex B for filter syntax)

tutorials/service-introspection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1170,7 +1170,7 @@ Remember to use introspection judiciously in production systems, considering the
11701170

11711171
For more information, see:
11721172

1173-
- [ROS 2 Service Introspection Documentation](https://docs.ros.org/en/kilted/Tutorials/Demos/Service-Introspection.html)
1173+
- [ROS 2 Service Introspection Documentation](https://docs.ros.org/en/lyrical/Tutorials/Demos/Service-Introspection.html)
11741174
- [rclnodejs API Documentation](https://robotwebtools.github.io/rclnodejs/docs/index.html)
11751175
- [Example service code](../example/services/service/service-example.js)
11761176
- [Introspection test cases](../test/test-service-introspection.js)

tutorials/type-description-service.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1457,7 +1457,7 @@ Remember to handle service availability gracefully and use appropriate error han
14571457

14581458
For more information, see:
14591459

1460-
- [ROS 2 Introspection Documentation](https://docs.ros.org/en/rolling/Concepts/About-ROS-Interfaces.html)
1460+
- [ROS 2 Introspection Documentation](https://docs.ros.org/en/lyrical/Concepts/About-ROS-Interfaces.html)
14611461
- [rclnodejs API Documentation](https://robotwebtools.github.io/rclnodejs/)
14621462
- [Type Description Service implementation](../lib/type_description_service.js)
14631463
- [Type Description Service tests](../test/test-type-description-service.js)

0 commit comments

Comments
 (0)