Skip to content

Add info on last tested commit#105

Open
j3soon wants to merge 1 commit intomainfrom
docs/last-tested
Open

Add info on last tested commit#105
j3soon wants to merge 1 commit intomainfrom
docs/last-tested

Conversation

@j3soon
Copy link
Owner

@j3soon j3soon commented Feb 5, 2026

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.

Summary by CodeRabbit

  • Documentation
    • Added "Last tested" verification notes to many module and workspace docs to surface recent test/commit information and placeholders for test dates across the documentation site.

@coderabbitai
Copy link

coderabbitai bot commented Feb 5, 2026

Walkthrough

This pull request inserts a "Last tested" blockquote line into 22 documentation files across workspace and docker-module docs. Changes are text-only additions near introductions or headers; no code, logic, or public API was modified.

Changes

Cohort / File(s) Summary
Workspace Documentation
docs/aloha-ws/index.md, docs/delto-gripper-ws/index.md, docs/gazebo-world-ws/index.md, docs/go2-ws/index.md, docs/h1-ws/index.md, docs/husky-ws/index.md, docs/kobuki-ws/index.md, docs/orbslam3-ws/index.md, docs/ros1-bridge-ws/index.md, docs/stretch3-ws/index.md, docs/template-ws/index.md, docs/turtlebot3-ws/index.md, docs/vlp-ws/index.md
Inserted a > Last tested ... blockquote (often "TODO" or a commit reference) near the top/introduction of each workspace README. Purely informational text additions.
Docker Module Documentation
docs/docker-modules/cartographer.md, docs/docker-modules/claude-code.md, docs/docker-modules/codex.md, docs/docker-modules/cuda-toolkit.md, docs/docker-modules/isaac-lab.md, docs/docker-modules/isaac-ros.md, docs/docker-modules/isaac-sim.md, docs/docker-modules/ros2.md, docs/docker-modules/rtabmap.md
Added a > Last tested ... blockquote (some include specific commit and author) after module headers. Documentation-only changes; no behavioral impact.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 I hopped through docs both near and far,
Left tiny notes like a bright little star,
"Last tested" whispers on pages new,
So future bunnies know what to do.
Hoppity-hop — docs updated, whoo! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding information about the last tested commit across multiple documentation files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/last-tested

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 11

🤖 Fix all issues with AI agents
In `@docs/delto-gripper-ws/index.md`:
- Line 14: Replace the placeholder line "Last tested on TODO." with the actual
commit reference and author info used elsewhere in the docs: insert the full
commit hash and the author name/email in the same format as other entries (e.g.,
"Last tested on <commit-hash> by <Author Name>"), ensuring you copy the exact
commit hash from the repository history for the tested state and replace the
TODO text accordingly.

In `@docs/docker-modules/cartographer.md`:
- Around line 7-8: Replace the placeholder line "Last tested on TODO." in
docs/docker-modules/cartographer.md with a concrete value or remove it: either
insert the actual commit hash or date/build tag used for the last successful
test (matching the style used in docs/stretch3-ws/index.md), or reword to a
non-specific statement (e.g., "Last tested on [date]") and remove the TODO
before merging so the published doc contains no visible TODO text.

In `@docs/docker-modules/cuda-toolkit.md`:
- Line 7: Replace the placeholder text "Last tested on TODO." with a concrete
identifier such as a commit hash (e.g., abc1234), a full date (e.g.,
2026-02-05), or both so the note is actionable; update the line containing "Last
tested on TODO." to read something like "Last tested on <commit-hash>
(<YYYY-MM-DD>)" or your chosen format.

In `@docs/docker-modules/isaac-lab.md`:
- Line 7: Replace the placeholder "TODO" in the "Last tested on TODO." line with
a concrete identifier of the tested state (either a full commit hash like "Last
tested on commit abc1234..." or an exact date like "Last tested on 2025-02-05");
ensure the entry points to the specific commit or tag used to verify the docs so
readers can reproduce the exact documented state.

In `@docs/docker-modules/isaac-ros.md`:
- Line 9: Replace the placeholder "Last tested on TODO." with the concrete
commit reference in the same format used elsewhere (commit hash and author),
e.g. "Last tested on <commit-hash> by <author-name>." Ensure the commit hash is
the exact tested commit and the author matches the repo attribution formatting
used in other docs.

In `@docs/h1-ws/index.md`:
- Line 14: Replace the placeholder text "Last tested on TODO." with a concrete
commit reference and author so the docs are actionable; update the line
containing "Last tested on TODO." to something like "Last tested on
<commit-hash> by <author-name>" (use the full commit SHA and the
committer/author name) and ensure the commit hash is accurate for the tested
state referenced in the rest of the doc.

In `@docs/kobuki-ws/index.md`:
- Line 14: Replace the placeholder "TODO" in the "Last tested on TODO." line
with a concrete commit hash or ISO date so users can reproduce the tested tree;
update the sentence to read e.g. "Last tested on <commit-hash>" or "Last tested
on YYYY-MM-DD" (use the commit SHA from the repo at test time or the exact date
of testing) and ensure the commit hash is full/short SHA consistently used
across docs.

In `@docs/orbslam3-ws/index.md`:
- Line 12: Replace the placeholder "Last tested on TODO." in
docs/orbslam3-ws/index.md with a concrete Git commit hash (and optionally a
date) that was used to verify the PR; locate the exact string "Last tested on
TODO." in the file and update it to something like "Last tested on <commit-hash>
(<YYYY-MM-DD>)" so the documentation records the specific tested revision.

In `@docs/ros1-bridge-ws/index.md`:
- Line 19: Replace the placeholder "Last tested on TODO." in the docs header
with a concrete identifier: update the exact line containing "Last tested on
TODO." to include the actual last-tested git commit hash (e.g. abc1234) and
optionally the date (e.g. 2026-02-05) so it reads like "Last tested on abc1234
(2026-02-05)"; ensure you use the real commit used for verification and keep the
wording/format consistent with other docs.

In `@docs/template-ws/index.md`:
- Line 14: Replace the placeholder "TODO" in the "Last tested on TODO." line
with a concrete identifier: the commit SHA (preferred) and optionally the date
used for testing (e.g., "Last tested on commit abc1234 (2026-02-05)"); update
the text exactly where the phrase appears so it reads with the chosen commit
hash and/or date to make the test reference reproducible.

In `@docs/vlp-ws/index.md`:
- Line 12: Replace the placeholder "Last tested on TODO." with a concrete commit
reference: include the short or full commit hash and the author (e.g., "Last
tested on <commit-hash> by <author-name>") and optionally the commit date;
update the line in docs/vlp-ws/index.md so the note reads a specific, actionable
reference rather than TODO.
🧹 Nitpick comments (1)
docs/docker-modules/codex.md (1)

7-7: Consider adding the test date next to the commit.

Including an explicit date (e.g., “Last tested on 2026‑02‑05, commit …”) makes troubleshooting easier when users compare instructions against time-bound dependency changes.


This repository will help you configure the environment for Delto Gripper quickly.

> Last tested on TODO.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace the TODO with a concrete commit reference.
User-facing docs shouldn’t ship with a placeholder; please include the tested commit hash and author (matching the format used elsewhere).

🤖 Prompt for AI Agents
In `@docs/delto-gripper-ws/index.md` at line 14, Replace the placeholder line
"Last tested on TODO." with the actual commit reference and author info used
elsewhere in the docs: insert the full commit hash and the author name/email in
the same format as other entries (e.g., "Last tested on <commit-hash> by <Author
Name>"), ensuring you copy the exact commit hash from the repository history for
the tested state and replace the TODO text accordingly.


CUDA Toolkit 12.6 Deb Install. (Not installed by default.)

> Last tested on TODO.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

Please fill in the actual last tested commit so the note is actionable.

🤖 Prompt for AI Agents
In `@docs/docker-modules/cuda-toolkit.md` at line 7, Replace the placeholder text
"Last tested on TODO." with a concrete identifier such as a commit hash (e.g.,
abc1234), a full date (e.g., 2026-02-05), or both so the note is actionable;
update the line containing "Last tested on TODO." to read something like "Last
tested on <commit-hash> (<YYYY-MM-DD>)" or your chosen format.


Isaac Lab 2.1.0 Git Install.

> Last tested on TODO.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

This should point to the tested commit so readers can reproduce the doc state.

🤖 Prompt for AI Agents
In `@docs/docker-modules/isaac-lab.md` at line 7, Replace the placeholder "TODO"
in the "Last tested on TODO." line with a concrete identifier of the tested
state (either a full commit hash like "Last tested on commit abc1234..." or an
exact date like "Last tested on 2025-02-05"); ensure the entry points to the
specific commit or tag used to verify the docs so readers can reproduce the
exact documented state.


Isaac ROS 3.2. (Not installed by default.)

> Last tested on TODO.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace the TODO with a concrete commit reference.
Please provide the tested commit hash and author, matching the format used in other docs.

🤖 Prompt for AI Agents
In `@docs/docker-modules/isaac-ros.md` at line 9, Replace the placeholder "Last
tested on TODO." with the concrete commit reference in the same format used
elsewhere (commit hash and author), e.g. "Last tested on <commit-hash> by
<author-name>." Ensure the commit hash is the exact tested commit and the author
matches the repo attribution formatting used in other docs.


This repository facilitates the quick configuration of the simulation environment and real robot driver for Kobuki.

> Last tested on TODO.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

Please fill in the tested commit so users can reset their tree accurately.

🤖 Prompt for AI Agents
In `@docs/kobuki-ws/index.md` at line 14, Replace the placeholder "TODO" in the
"Last tested on TODO." line with a concrete commit hash or ISO date so users can
reproduce the tested tree; update the sentence to read e.g. "Last tested on
<commit-hash>" or "Last tested on YYYY-MM-DD" (use the commit SHA from the repo
at test time or the exact date of testing) and ensure the commit hash is
full/short SHA consistently used across docs.

![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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

The PR objective is to record the last tested commit; leaving a TODO defeats that purpose. Please fill in a specific commit hash (and optionally a date).

🤖 Prompt for AI Agents
In `@docs/orbslam3-ws/index.md` at line 12, Replace the placeholder "Last tested
on TODO." in docs/orbslam3-ws/index.md with a concrete Git commit hash (and
optionally a date) that was used to verify the PR; locate the exact string "Last
tested on TODO." in the file and update it to something like "Last tested on
<commit-hash> (<YYYY-MM-DD>)" so the documentation records the specific tested
revision.


This workspace is utilized to create a bridge between ROS1 and ROS2-humble.

> Last tested on TODO.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

Please provide the actual last tested commit (and optionally the date) so users can reset their tree as intended.

🤖 Prompt for AI Agents
In `@docs/ros1-bridge-ws/index.md` at line 19, Replace the placeholder "Last
tested on TODO." in the docs header with a concrete identifier: update the exact
line containing "Last tested on TODO." to include the actual last-tested git
commit hash (e.g. abc1234) and optionally the date (e.g. 2026-02-05) so it reads
like "Last tested on abc1234 (2026-02-05)"; ensure you use the real commit used
for verification and keep the wording/format consistent with other docs.


This template will help you set up a ROS-Humble environment quickly.

> Last tested on TODO.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

To make debugging reproducible, this should reference the tested commit hash (and optionally the date).

🤖 Prompt for AI Agents
In `@docs/template-ws/index.md` at line 14, Replace the placeholder "TODO" in the
"Last tested on TODO." line with a concrete identifier: the commit SHA
(preferred) and optionally the date used for testing (e.g., "Last tested on
commit abc1234 (2026-02-05)"); update the text exactly where the phrase appears
so it reads with the chosen commit hash and/or date to make the test reference
reproducible.

![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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace the TODO with a concrete commit reference.
Please include the tested commit hash and author to keep the note actionable.

🤖 Prompt for AI Agents
In `@docs/vlp-ws/index.md` at line 12, Replace the placeholder "Last tested on
TODO." with a concrete commit reference: include the short or full commit hash
and the author (e.g., "Last tested on <commit-hash> by <author-name>") and
optionally the commit date; update the line in docs/vlp-ws/index.md so the note
reads a specific, actionable reference rather than TODO.

@j3soon
Copy link
Owner Author

j3soon commented Feb 5, 2026

This PR will allow better tracking of the time when each workspace/modules are last tested. Since the turtlebot3 workspace and the Isaac ROS module seems to be found failing.

@YuZhong-Chen @Assume-Zhan @JustinShih0918 @yuhsiang1117, would appreciate if you can help me fill in the TODOs. Let me know when did you last tested each of the workspaces/modules (and better if you know which commit) in the comments, thanks!

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.
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@docs/docker-modules/rtabmap.md`:
- Around line 5-6: Replace the placeholder "TODO" in the line containing "Last
tested on TODO." with a concrete reproducible identifier: either a full git
commit hash (e.g., 40-char SHA) or an exact test date and time (YYYY-MM-DD or
YYYY-MM-DD HH:MM UTC); update the sentence to read like "Last tested on <commit
SHA>" or "Last tested on <YYYY-MM-DD>" so readers can reproduce the documented
state and verify which commit/date was used.

Comment on lines +5 to +6
> Last tested on TODO.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Replace “TODO” with a concrete commit or date.

Readers need a specific commit hash or exact test date to reproduce the documented state.

🤖 Prompt for AI Agents
In `@docs/docker-modules/rtabmap.md` around lines 5 - 6, Replace the placeholder
"TODO" in the line containing "Last tested on TODO." with a concrete
reproducible identifier: either a full git commit hash (e.g., 40-char SHA) or an
exact test date and time (YYYY-MM-DD or YYYY-MM-DD HH:MM UTC); update the
sentence to read like "Last tested on <commit SHA>" or "Last tested on
<YYYY-MM-DD>" so readers can reproduce the documented state and verify which
commit/date was used.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant