From 54241780432b4848e7572579d5f6d0afd98a4036 Mon Sep 17 00:00:00 2001 From: Johnson Sun Date: Fri, 6 Feb 2026 07:05:00 +0800 Subject: [PATCH] docs: Add info on last tested commit This enables easier debugging if errors are observed when following the docs. For example, one can reset to that commit to see if the instructions are still working. If not, then the error might be due to some upstream dependency changes. --- docs/aloha-ws/index.md | 5 +++-- docs/delto-gripper-ws/index.md | 2 ++ docs/docker-modules/cartographer.md | 2 ++ docs/docker-modules/claude-code.md | 2 ++ docs/docker-modules/codex.md | 2 ++ docs/docker-modules/cuda-toolkit.md | 2 ++ docs/docker-modules/isaac-lab.md | 2 ++ docs/docker-modules/isaac-ros.md | 2 ++ docs/docker-modules/isaac-sim.md | 2 ++ docs/docker-modules/newton-tools.md | 2 ++ docs/docker-modules/nv-openusd.md | 2 ++ docs/docker-modules/ros2.md | 2 ++ docs/docker-modules/rtabmap.md | 2 ++ docs/gazebo-world-ws/index.md | 2 ++ docs/go2-ws/index.md | 2 ++ docs/h1-ws/index.md | 2 ++ docs/husky-ws/index.md | 2 ++ docs/kobuki-ws/index.md | 2 ++ docs/orbslam3-ws/index.md | 2 ++ docs/ros1-bridge-ws/index.md | 2 ++ docs/stretch3-ws/index.md | 2 ++ docs/template-ws/index.md | 2 ++ docs/turtlebot3-ws/index.md | 3 +++ docs/vlp-ws/index.md | 2 ++ 24 files changed, 50 insertions(+), 2 deletions(-) diff --git a/docs/aloha-ws/index.md b/docs/aloha-ws/index.md index aa1a42174..9594420c8 100644 --- a/docs/aloha-ws/index.md +++ b/docs/aloha-ws/index.md @@ -9,10 +9,11 @@ ![Docker image version](https://img.shields.io/docker/v/j3soon/ros2-aloha-ws) ![Docker image size](https://img.shields.io/docker/image-size/j3soon/ros2-aloha-ws) -> This workspace may only work with Isaac Sim 4.5.0, and require code update to support the latest version. - +> This workspace may only work with Isaac Sim 4.5.0, and require code update to support the latest version. > (TODO: Update the code to support the latest Isaac Sim. Refer to the commit history of [turtlebot3-ws](../turtlebot3-ws/) for more details.) +> Last tested on commit [d24f0a1](https://github.com/j3soon/ros2-essentials/commit/d24f0a12609ffb2aea245cba4462e46b18577e4e) by [@j3soon](https://github.com/j3soon). + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/delto-gripper-ws/index.md b/docs/delto-gripper-ws/index.md index 4c7c21b6b..6b35850dd 100644 --- a/docs/delto-gripper-ws/index.md +++ b/docs/delto-gripper-ws/index.md @@ -11,6 +11,8 @@ This repository will help you configure the environment for Delto Gripper quickly. +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/docker-modules/cartographer.md b/docs/docker-modules/cartographer.md index e01436584..515bfb1a3 100644 --- a/docs/docker-modules/cartographer.md +++ b/docs/docker-modules/cartographer.md @@ -4,6 +4,8 @@ ROS2 Cartographer. (Only installed by default for the template workspace.) +> Last tested on TODO. + To enable Cartographer, set the `CARTOGRAPHER` argument to `YES` in the `compose.yaml` file of your desired workspace (e.g., `husky_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image. > TODO: Remove duplicate content from the template workspace below. diff --git a/docs/docker-modules/claude-code.md b/docs/docker-modules/claude-code.md index d38d323ad..e8d948d6e 100644 --- a/docs/docker-modules/claude-code.md +++ b/docs/docker-modules/claude-code.md @@ -4,6 +4,8 @@ Claude Code CLI for AI-assisted development directly inside workspace containers. +> Last tested on commit [d43ad1c](https://github.com/j3soon/ros2-essentials/commit/d43ad1c11075808d5fbf194c5979ffedec213b5e) by [@j3soon](https://github.com/j3soon). + To enable Claude Code CLI, set the `CLAUDE_CODE` argument to `YES` in the `compose.yaml` file of your desired workspace (e.g., `template_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image. > **Notice - Subscription required:** Claude Code is a third-party service that requires an active Anthropic account or subscription to use. This module only installs the CLI; you need an active subscription to use it. diff --git a/docs/docker-modules/codex.md b/docs/docker-modules/codex.md index a7b15c256..2d256156d 100644 --- a/docs/docker-modules/codex.md +++ b/docs/docker-modules/codex.md @@ -4,6 +4,8 @@ Codex CLI for AI-assisted development directly inside workspace containers. +> Last tested on commit [d43ad1c](https://github.com/j3soon/ros2-essentials/commit/d43ad1c11075808d5fbf194c5979ffedec213b5e) by [@j3soon](https://github.com/j3soon). + To enable Codex CLI, set the `CODEX` argument to `YES` in the `compose.yaml` file of your desired workspace (e.g., `template_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image. > **Notice - Subscription required:** Codex is a third-party service that requires an active OpenAI account or subscription to use. This module only installs the CLI; you need an active subscription to use it. diff --git a/docs/docker-modules/cuda-toolkit.md b/docs/docker-modules/cuda-toolkit.md index c218c9841..514c675a9 100644 --- a/docs/docker-modules/cuda-toolkit.md +++ b/docs/docker-modules/cuda-toolkit.md @@ -4,6 +4,8 @@ CUDA Toolkit 12.6 Deb Install. (Not installed by default.) +> Last tested on commit [14e949a](https://github.com/j3soon/ros2-essentials/commit/14e949ae986aee39cc7913a804ba07b50b5b3855) by [@j3soon](https://github.com/j3soon). + To enable CUDA Toolkit, set the `CUDA_TOOLKIT_VERSION` argument to `12.6` in the `compose.yaml` file of your desired workspace (e.g., `template_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image. Make sure your GPU driver version supports the CUDA Toolkit version you want to install. For example, CUDA 12.6 requires Linux driver version >=560.35.05 on x86_64. See [Table 3 in the CUDA Toolkit Release Notes](https://docs.nvidia.com/cuda/cuda-toolkit-release-notes/index.html) for more information. diff --git a/docs/docker-modules/isaac-lab.md b/docs/docker-modules/isaac-lab.md index 1257139a7..cafb65701 100644 --- a/docs/docker-modules/isaac-lab.md +++ b/docs/docker-modules/isaac-lab.md @@ -4,6 +4,8 @@ Isaac Lab 2.1.0 Git Install. +> Last tested on commit [1f46f18](https://github.com/j3soon/ros2-essentials/commit/1f46f185edc1cd624c7bb42590be095c776364e5) by [@j3soon](https://github.com/j3soon). + Depends on: - Vulkan Configuration diff --git a/docs/docker-modules/isaac-ros.md b/docs/docker-modules/isaac-ros.md index ae28078a1..34e9d825f 100644 --- a/docs/docker-modules/isaac-ros.md +++ b/docs/docker-modules/isaac-ros.md @@ -6,6 +6,8 @@ Isaac ROS 3.2. (Not installed by default.) +> Last tested on commit [14e949a](https://github.com/j3soon/ros2-essentials/commit/14e949ae986aee39cc7913a804ba07b50b5b3855) by [@j3soon](https://github.com/j3soon). + Depends on: - ROS 2 Humble diff --git a/docs/docker-modules/isaac-sim.md b/docs/docker-modules/isaac-sim.md index 47e8c0280..88d12a7e4 100644 --- a/docs/docker-modules/isaac-sim.md +++ b/docs/docker-modules/isaac-sim.md @@ -4,6 +4,8 @@ Isaac Sim 5.0.0 Binary Install. +> Last tested on commit [d43ad1c](https://github.com/j3soon/ros2-essentials/commit/d43ad1c11075808d5fbf194c5979ffedec213b5e) by [@j3soon](https://github.com/j3soon). + Depends on: - Vulkan Configuration diff --git a/docs/docker-modules/newton-tools.md b/docs/docker-modules/newton-tools.md index 01274cd96..c9e6849fb 100644 --- a/docs/docker-modules/newton-tools.md +++ b/docs/docker-modules/newton-tools.md @@ -6,6 +6,8 @@ URDF-to-USD and MJCF-to-USD converter tools from Newton Physics. To enable Newton Tools, set the `NEWTON_TOOLS` argument to `YES` in the `compose.yaml` file of your desired workspace (e.g., `template_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image. +> Last tested on commit [1e1cd11](https://github.com/j3soon/ros2-essentials/commit/1e1cd1164077924c226c39557d4a384042522a00) by [@j3soon](https://github.com/j3soon). + ## Usage The module installs these converters via pip during Docker image build: diff --git a/docs/docker-modules/nv-openusd.md b/docs/docker-modules/nv-openusd.md index 35411dd35..4349b7f77 100644 --- a/docs/docker-modules/nv-openusd.md +++ b/docs/docker-modules/nv-openusd.md @@ -6,6 +6,8 @@ To enable NVIDIA OpenUSD tools, set the `NV_OPENUSD` argument to `YES` in the `compose.yaml` file of your desired workspace (e.g., `template_ws/docker/compose.yaml`). After making these changes, rebuild the Docker image. +> Last tested on commit [1e1cd11](https://github.com/j3soon/ros2-essentials/commit/1e1cd1164077924c226c39557d4a384042522a00) by [@j3soon](https://github.com/j3soon). + ## Usage These OpenUSD tools are often very useful for working with USD files directly without needing to launch Isaac Sim. diff --git a/docs/docker-modules/ros2.md b/docs/docker-modules/ros2.md index 1bd88212b..3649cdcd4 100644 --- a/docs/docker-modules/ros2.md +++ b/docs/docker-modules/ros2.md @@ -3,3 +3,5 @@ [![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/blob/main/docker_modules/install_ros.sh) Robot Operating System 2 (ROS 2) Humble Apt Install. + +> Last tested on commit [14e949a](https://github.com/j3soon/ros2-essentials/commit/14e949ae986aee39cc7913a804ba07b50b5b3855) by [@j3soon](https://github.com/j3soon). diff --git a/docs/docker-modules/rtabmap.md b/docs/docker-modules/rtabmap.md index 56d4ea152..3037ffb19 100644 --- a/docs/docker-modules/rtabmap.md +++ b/docs/docker-modules/rtabmap.md @@ -2,6 +2,8 @@ [![GitHub code](https://img.shields.io/badge/code-blue?logo=github&label=github)](https://github.com/j3soon/ros2-essentials/blob/main/docker_modules/install_rtabmap.sh) +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/gazebo-world-ws/index.md b/docs/gazebo-world-ws/index.md index 350ff96cb..834dd3605 100644 --- a/docs/gazebo-world-ws/index.md +++ b/docs/gazebo-world-ws/index.md @@ -11,6 +11,8 @@ This repository contains several Gazebo worlds, which are valuable for testing robots or agents in both indoor and outdoor environments. +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/go2-ws/index.md b/docs/go2-ws/index.md index 2dae7712a..03dd40bb1 100644 --- a/docs/go2-ws/index.md +++ b/docs/go2-ws/index.md @@ -11,6 +11,8 @@ > Please note that this workspace is only tested in simulation. +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/h1-ws/index.md b/docs/h1-ws/index.md index c27d30878..7ac879cc5 100644 --- a/docs/h1-ws/index.md +++ b/docs/h1-ws/index.md @@ -11,6 +11,8 @@ > Please note that this workspace is only tested in simulation. +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/husky-ws/index.md b/docs/husky-ws/index.md index 6404cbb82..3d29364ab 100644 --- a/docs/husky-ws/index.md +++ b/docs/husky-ws/index.md @@ -11,6 +11,8 @@ This repository will help you configure the environment for Husky quickly. +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/kobuki-ws/index.md b/docs/kobuki-ws/index.md index 8f4b1351f..8d004cb5a 100644 --- a/docs/kobuki-ws/index.md +++ b/docs/kobuki-ws/index.md @@ -11,6 +11,8 @@ This repository facilitates the quick configuration of the simulation environment and real robot driver for Kobuki. +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/orbslam3-ws/index.md b/docs/orbslam3-ws/index.md index dbbc3e709..f0a7b21b1 100644 --- a/docs/orbslam3-ws/index.md +++ b/docs/orbslam3-ws/index.md @@ -9,6 +9,8 @@ ![Docker image version](https://img.shields.io/docker/v/j3soon/ros2-orbslam3-ws) ![Docker image size](https://img.shields.io/docker/image-size/j3soon/ros2-orbslam3-ws) +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/ros1-bridge-ws/index.md b/docs/ros1-bridge-ws/index.md index d7fc6b89b..77db4c54e 100644 --- a/docs/ros1-bridge-ws/index.md +++ b/docs/ros1-bridge-ws/index.md @@ -16,6 +16,8 @@ This workspace is utilized to create a bridge between ROS1 and ROS2-humble. +> Last tested on TODO. + ## ◻️ Introduction ◻️ `ros1_bridge` provides a network bridge that enables the exchange of messages between ROS 1 and ROS 2. diff --git a/docs/stretch3-ws/index.md b/docs/stretch3-ws/index.md index bf670c7aa..3f6e96763 100644 --- a/docs/stretch3-ws/index.md +++ b/docs/stretch3-ws/index.md @@ -11,6 +11,8 @@ > Please note that this workspace is only tested in simulation. +> Last tested on commit [a9e1166](https://github.com/j3soon/ros2-essentials/commit/a9e116664353b8d874d7e559d023c625b08c9dd1) by [@j3soon](https://github.com/j3soon). + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/template-ws/index.md b/docs/template-ws/index.md index d8d388e7a..2d5d3b511 100644 --- a/docs/template-ws/index.md +++ b/docs/template-ws/index.md @@ -11,6 +11,8 @@ This template will help you set up a ROS-Humble environment quickly. +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/turtlebot3-ws/index.md b/docs/turtlebot3-ws/index.md index 258d33c74..ae4459316 100644 --- a/docs/turtlebot3-ws/index.md +++ b/docs/turtlebot3-ws/index.md @@ -11,6 +11,9 @@ > Please note that this workspace is only tested in simulation. +> Last tested (Isaac Sim only) on commit [bdbb82d](https://github.com/j3soon/ros2-essentials/commit/bdbb82d1a67c7c34b21fbc5c9ed4b795acd20c4d) by [@j3soon](https://github.com/j3soon). +> Last tested on commit [e8f1c8d](https://github.com/j3soon/ros2-essentials/commit/e8f1c8dd1880e1e2126ffcde93a2256acc11e6f7) by [@j3soon](https://github.com/j3soon). + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace. diff --git a/docs/vlp-ws/index.md b/docs/vlp-ws/index.md index f2c5799e8..15213baf2 100644 --- a/docs/vlp-ws/index.md +++ b/docs/vlp-ws/index.md @@ -9,6 +9,8 @@ ![Docker image version](https://img.shields.io/docker/v/j3soon/ros2-vlp-ws) ![Docker image size](https://img.shields.io/docker/image-size/j3soon/ros2-vlp-ws) +> Last tested on TODO. + ## 🐳 Start Container > Make sure your system meets the [system requirements](https://j3soon.github.io/ros2-essentials/#system-requirements) and have followed the [setup instructions](https://j3soon.github.io/ros2-essentials/#setup) before using this workspace.