Skip to content

Update Jetson setup and driver stack docs for beginner-friendliness#80

Merged
AhmadAmine998 merged 11 commits into
f1tenth:mainfrom
MLN-MNJ:update-jetson-and-driver-stack-docs
Jul 1, 2026
Merged

Update Jetson setup and driver stack docs for beginner-friendliness#80
AhmadAmine998 merged 11 commits into
f1tenth:mainfrom
MLN-MNJ:update-jetson-and-driver-stack-docs

Conversation

@MLN-MNJ

@MLN-MNJ MLN-MNJ commented Jun 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

Reworked the Configure Jetson and Peripherals and Install RoboRacer Driver Stack sections to be clearer and easier for beginners to follow.

Changes

  • Merged "Configuring the NVIDIA Jetson NX" and "Connecting the Pit/Host and the NVIDIA Jetson NX" into one page; flashing now points to the NVIDIA SDK Manager and WiFi is configured via the GUI.
  • VESC firmware: updated the firmware step for the current VESC Tool (use Download Latest; the old "Show non-default firmwares / VESC_servoout.bin" flow no longer works).
  • Driver stack: rewritten for ROS 2 Humble (ros-humble-ros-base, rosdep, humble-devel, colcon), with clearer udev rules (+ a nano tip) and an asio_cmake_module build note.
  • LiDAR: added SICK ethernet LiDAR setup (with screenshots); folded the Hokuyo 10LX ethernet config into the driver stack page and removed the standalone Hokuyo page.
  • Reordered the firmware section and renumbered pages accordingly.
  • Fixes: typos, a broken command (run_container.sh), and uncommented figure captions so screenshots are labeled and the docs build cleanly.

Builds cleanly with Sphinx (no new warnings on the edited pages).

- Merge "Configuring the NVIDIA Jetson NX" and "Connecting the Pit/Host"
  into one page; flash via NVIDIA SDK Manager and connect WiFi via the GUI
- Rewrite the VESC firmware step for the current VESC Tool (Download Latest)
- Rewrite the driver stack setup for ROS 2 Humble (ros-base, rosdep,
  humble-devel, colcon) with clearer udev rules and a nano tip
- Add SICK ethernet LiDAR setup with screenshots; fold the Hokuyo 10LX
  ethernet config into the driver stack page and remove the standalone page
- Reorder the firmware section (LiDAR setup moved into the stack page)
- Fix typos, a broken command (run_container.sh), and uncomment figure
  captions so screenshots are labeled and the build is clean
@AhmadAmine998 AhmadAmine998 self-requested a review June 30, 2026 20:53
@AhmadAmine998 AhmadAmine998 self-assigned this Jun 30, 2026
@AhmadAmine998

Copy link
Copy Markdown
Collaborator

I updated this PR to also resolve several long-standing issues, incorporate two other open PRs, and add docs CI so it can serve as the main docs release.

What's added

Closes / supersedes

Closes #48
Closes #53
Closes #57
Closes #75
Closes #78

Supersedes #79 (incorporated here, authorship preserved) and #69 (the run_container.sh typo is already fixed in this branch).

CI / build

sphinx-build -W --keep-going -b html passes with 0 warnings. The new build-docs GitHub Action runs this on every PR.

Notes

Part of a docs rework toward a versioned structure (main = latest/Humble, foxy frozen, ros1 legacy). A follow-up PR will handle deprecated-content removal (TX2 / old ROS 1 sim), replace the in-repo simulator guide with a pointer to f1tenth_gym, rewrite the README, and add inline .. todo:: flags for the hardware refresh (Xavier NX → Orin, new top-plate schematic).

@AhmadAmine998 AhmadAmine998 merged commit 90cfbfe into f1tenth:main Jul 1, 2026
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.

3 participants