update: first steps tutorial

iltgg · iltgg · commit 924a032585a1 · 2025-10-14T21:58:35.000-04:00
diff --git a/docs/Multirotor/Tutorials/First_Steps/1._Developer_Environment.md b/docs/Multirotor/Tutorials/First_Steps/1._Developer_Environment.md
@@ -90,13 +90,13 @@ We will go over Git as we need it, but if you have no experience and would like
 
 ### VS Code
 
-VS Code is an extendable text editor developed by Microsoft.
+VS Code is a popular text editor developed by Microsoft, it is highly extendable with many plugins existing that can turn it into a fully featured integrated development environment (IDE).
 
 Install VS Code if you haven't already: [https://code.visualstudio.com/](https://code.visualstudio.com/)
 
-You will also need the dev containers extension, just search for "dev containers" or see here: [https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
+You will also need the dev containers extension, just search for "dev containers" in the extension tab (`Ctrl+Shift+X`) or see here: [https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
 
-If you'd like to learn more bout dev containers see here for the full overview: [https://code.visualstudio.com/docs/devcontainers/containers](https://code.visualstudio.com/docs/devcontainers/containers)
+If you'd like to learn more about dev containers see here for the full overview: [https://code.visualstudio.com/docs/devcontainers/containers](https://code.visualstudio.com/docs/devcontainers/containers)
 
 ### GitHub
 
@@ -132,6 +132,7 @@ Eventually you should see `Done. Press any key to close the terminal.`
     g++-multilib-arm-linux-gnueabi
     g++-multilib-arm-linux-gnueabihf
     ```
+    Otherwise build the container with x86 emulation or use a VM.
 
 ## Next
 
diff --git a/docs/Multirotor/Tutorials/First_Steps/2._Interacting_with_the_Environment.md b/docs/Multirotor/Tutorials/First_Steps/2._Interacting_with_the_Environment.md
@@ -62,7 +62,7 @@ If you are coming from Windows `apt` is similar to `winget`, `scoop`, or `choco`
 
 Before you start you will have to enable `X11` pass through, `X11` is a windowing system that allows programs to draw to the screen and is how the container will create windows on our host computer.
 
-For Linux the container is already setup to mount the `X11` socket and configure `$DISPLAY`, but you may have to run `xhost +local:docker` if nothing shows up when you run the simulation. (this command allows non-network local connects to access the X server)
+For Linux the container is already setup to mount the `X11` socket and configure `$DISPLAY`, but you may have to run `xhost +local:docker` if nothing shows up when you run the simulation. (this command allows non-network local connections to access the X server)
 
 For Windows see: [https://medium.com/@potatowagon/how-to-use-gui-apps-in-linux-docker-container-from-windows-host-485d3e1c64a3](https://medium.com/@potatowagon/how-to-use-gui-apps-in-linux-docker-container-from-windows-host-485d3e1c64a3)
 
@@ -77,7 +77,6 @@ If you pan around the scene with your mouse and you are getting more than 10fps
     See the `WSL2` note back on [Developer Environment](./1._Developer_Environment.md) <br>
     Otherwise a good a place to start is to search `docker <operating system> <amd/intel/nvidia> <desktop/laptop> gpu`.
 
-
 If you want to fly the drone you can use the commands on the left of the app like `Takeoff`, after the drone takes off you can also click on places on the map and tell the drone to fly there. If the simulator does not let you take off please resolve the warnings.
 
 You can also control the drone with a virtual joystick (a little difficult to use without a touch screen) to enable go to `Application Settings > Fly View > Virtual Joystick`.
diff --git a/docs/Multirotor/Tutorials/First_Steps/3._Recommended_Tutorials.md b/docs/Multirotor/Tutorials/First_Steps/3._Recommended_Tutorials.md
@@ -2,6 +2,26 @@
 title: Recommended Tutorials
 ---
 
+
+## C++, Python
+
+Learning an new programming language (or improving your skills) depends on many factors that this tutorial cannot account for.
+
+If you have *no* experience at all, your 100 level programming course *might* be a good place to start. If you'd like more guidance ask your lead(s) and they will help you out.
+
+If you have some experience in any programming language, you should be able to pick up most things you need by going through the tutorials and searching/LLMing things that you don't recognize.
+
+If you'd like to go through some **very comprehensive** tutorials/guides before you start any UAS specific stuff here are the good ones:
+
+- [https://docs.python.org/3/tutorial/index.html](https://docs.python.org/3/tutorial/index.html)
+- [https://www.learncpp.com/](https://www.learncpp.com/)
+
+## Linux
+
+The previous tutorial should (I'm hoping) give you enough context to start the ROS2 tutorials. Most commands and concepts you should be able to pickup as you go.
+
+If you'd like to go even further the most immediately relevant "Linux topics" will be sysadmin related. I don't have any recommended tutorials, but topics of note include `processes` `package managment`, `networking`, `tailsale`, `udev`, and `systemd`.
+
 ## ROS2
 
 > The Robot Operating System (ROS) is a set of software libraries and tools for building robot applications. From drivers and state-of-the-art algorithms to powerful developer tools, ROS has the open source tools you need for your next robotics project.
@@ -10,13 +30,27 @@ For our team ROS2 acts as the middleware the binds all of our systems together,
 
 Main documentation: [https://docs.ros.org/en/humble/index.html](https://docs.ros.org/en/humble/index.html)
 
-To get started go through the beginner tutorials: [https://docs.ros.org/en/humble/Tutorials.html](https://docs.ros.org/en/humble/Tutorials.html)
-
-You can skip the `Configuring environment` section if you are using the development container, but I would read it anyways.
+Recommend Tutorials to complete: [https://docs.ros.org/en/humble/Tutorials.html](https://docs.ros.org/en/humble/Tutorials.html)
+
+- All of `Beginner: CLI tools`
+    - Most of `Configuring environment` has been done for you if you are using the development container, but you should read it anyways to get familiar with the CLI.
+        - We do not set `ROS_LOCALHOST_ONLY=1` because the container is not setup for `network_mode: host`
+- Most of `Beginner: Client libraries`
+    - Using colcon to build packages
+    - Creating a workspace
+    - Creating a package
+    - Writing a simple publisher and subscriber (C++)
+    - Writing a simple publisher and subscriber (Python)
+    - Writing a simple service and client (C++)
+    - Writing a simple service and client (Python)
+    - Creating custom msg and srv files
+    - Implementing custom interfaces
+    - Using parameters in a class (C++)
+    - Using parameters in a class (Python)
 
 I recommend using using the `uas_ws` directory for your workspace as the container's `.bashrc` comes preconfigured to use this workspace.
 
-The basic concepts page is also a good place to learn more about ROS: [https://docs.ros.org/en/humble/Concepts.html](https://docs.ros.org/en/humble/Concepts.html)
+The concepts page is good place to learn more about the inner workings of ROS: [https://docs.ros.org/en/humble/Concepts.html](https://docs.ros.org/en/humble/Concepts.html)
 
 ## PX4
 
@@ -32,6 +66,10 @@ Read the basic concepts page to get familiar with basic drone concepts: [https:/
 
 We make heavy use of offboard control for our autonomy, specially we use ROS2 and the uXRCE-DDS interface, there are quite a few pages, but skim a few to get a feel for what we are working with: [https://docs.px4.io/main/en/ros/offboard_control.html](https://docs.px4.io/main/en/ros/offboard_control.html)
 
+Recommended "Tutorial": [https://docs.px4.io/main/en/ros2/offboard_control](https://docs.px4.io/main/en/ros2/offboard_control)
+
+- Follow the instructions to install
+
 We are specifically using the uXRCE-DDS bridge to communicate with the drone, see here to learn more about its implementation: [https://docs.px4.io/main/en/middleware/uxrce_dds.html](https://docs.px4.io/main/en/middleware/uxrce_dds.html)
 
 ## Gazebo
@@ -44,7 +82,7 @@ Main documentation: [https://gazebosim.org/docs/harmonic/tutorials/](https://gaz
 
 ## Onboarding Project
 
-The best way to get familiar with the basics is by doing as such I have scoped a smallish scale learning project that you can undertake (not for marks).
+The best way to get learn the basics is by doing, as such I have scoped a smallish scale learning project that you can undertake (not for marks).
 
 To get started create a ROS package in `uas_ws/src`, use the PX4 offboard docs as reference.
 
diff --git a/docs/Multirotor/Tutorials/First_Steps/index.md b/docs/Multirotor/Tutorials/First_Steps/index.md
@@ -2,6 +2,21 @@
 title: First Steps
 ---
 
+## Introduction
+
+These tutorials cover the installation of a developer environment for working with ROS2+PX4, basic navigation within the environment, and conclude with tutorial recommendations and an onboarding project.
+
+Knowledge assumptions:
+
+- These tutorials assume some knowledge of programming (C++ or Python)
+- These tutorials assume some knowledge of git
+- These tutorials assume limited knowledge of the terminal
+- These tutorials assume no knowledge of Linux
+- These tutorials assume no knowledge of dev-containers
+- These tutorials assume no knowledge of ROS2, PX4, etc.
+
+## Index
+
 1. [Developer Environment](./1._Developer_Environment.md)
 2. [Interacting with the Environment](./2._Interacting_with_the_Environment.md)
 3. [Recommended Tutorials](./3._Recommended_Tutorials.md)
