From ff9c703289da5bfba5adb423b6e9ee9f99ca5aa0 Mon Sep 17 00:00:00 2001 From: Zayan Khan <108294002+ZayanKhan-12@users.noreply.github.com> Date: Fri, 7 Aug 2026 13:41:07 -0400 Subject: [PATCH] Fix doc links broken by the openpilot/ restructure (#38467) --- openpilot/system/camerad/webcam/README.md | 2 +- openpilot/tools/plotjuggler/README.md | 2 +- tools/CTF.md | 2 +- tools/README.md | 13 +++++++++---- 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/openpilot/system/camerad/webcam/README.md b/openpilot/system/camerad/webcam/README.md index 17d7ee6d80..7fa28a9919 100644 --- a/openpilot/system/camerad/webcam/README.md +++ b/openpilot/system/camerad/webcam/README.md @@ -1,7 +1,7 @@ # Run openpilot with webcam on PC ## Setup openpilot -- Follow [this readme](../README.md) to install and build the requirements +- Follow [this readme](/tools/README.md) to install and build the requirements ## Connect the hardware - Connect the camera first diff --git a/openpilot/tools/plotjuggler/README.md b/openpilot/tools/plotjuggler/README.md index efccbdc0bd..e87fc2c3d4 100644 --- a/openpilot/tools/plotjuggler/README.md +++ b/openpilot/tools/plotjuggler/README.md @@ -4,7 +4,7 @@ ## Installation -Once you've [set up the openpilot environment](../README.md), this command will download PlotJuggler and install our plugins: +Once you've [set up the openpilot environment](/tools/README.md), this command will download PlotJuggler and install our plugins: `cd openpilot/tools/plotjuggler && ./juggle.py --install` diff --git a/tools/CTF.md b/tools/CTF.md index 2b877a0e25..ae7bea09c2 100644 --- a/tools/CTF.md +++ b/tools/CTF.md @@ -5,7 +5,7 @@ Welcome to the first part of the comma CTF! * there's 2 flags in each segment, with roughly increasing difficulty * everything you'll need to find the flags is in the openpilot repo * grep is also your friend - * first, [setup](https://github.com/commaai/openpilot/tree/master/openpilot/tools#setup-your-pc) your PC + * first, [setup](https://github.com/commaai/openpilot/tree/master/tools) your PC * read the docs & checkout out the tools in openpilot/tools/ * tip: once you get the replay and UI up, start by familiarizing yourself with seeking in replay diff --git a/tools/README.md b/tools/README.md index 1ea42bbe1d..ae36282828 100644 --- a/tools/README.md +++ b/tools/README.md @@ -45,6 +45,14 @@ Learn about the openpilot ecosystem and tools by playing our [CTF](/tools/CTF.md ## Directory Structure +``` +├── car_porting/ # Tools for porting new cars +├── release/ # Scripts for building openpilot releases +└── scripts/ # Miscellaneous scripts +``` + +Development tools such as cabana, plotjuggler, and replay live in [openpilot/tools/](/openpilot/tools/): + ``` ├── cabana/ # View and plot CAN messages from drives or in realtime ├── camerastream/ # Cameras stream over the network @@ -52,8 +60,5 @@ Learn about the openpilot ecosystem and tools by playing our [CTF](/tools/CTF.md ├── lib/ # Libraries to support the tools and reading openpilot logs ├── plotjuggler/ # A tool to plot openpilot logs ├── replay/ # Replay drives and mock openpilot services -├── scripts/ # Miscellaneous scripts -├── serial/ # Tools for using the comma serial -├── sim/ # Run openpilot in a simulator -└── webcam/ # Run openpilot on a PC with webcams +└── sim/ # Run openpilot in a simulator ```