hid all todos and dev setup. added environment setup pictures for espidf

tguyenn · tguyenn · commit ea5672a95b0f · 2025-09-15T17:25:48.000-05:00
diff --git a/docs/_assets/images/espidf_448.png b/docs/_assets/images/espidf_448.png
diff --git a/docs/_assets/images/espidf_configure.png b/docs/_assets/images/espidf_configure.png
diff --git a/docs/_assets/images/espidf_express.png b/docs/_assets/images/espidf_express.png
diff --git a/docs/_assets/images/espidf_extension.png b/docs/_assets/images/espidf_extension.png
diff --git a/docs/_assets/images/espidf_showalltags.png b/docs/_assets/images/espidf_showalltags.png
diff --git a/docs/_assets/images/robotathon_shelf.jpg b/docs/_assets/images/robotathon_shelf.jpg
diff --git a/docs/_sections/_guide-FAQ/competition_logistics.md b/docs/_sections/_guide-FAQ/competition_logistics.md
@@ -22,17 +22,19 @@ These TIW materials will (most likely) include your chassis and your mechanical
 
 ## Where can we store our robot?
 
-You can store your robot on the RAS Office's (EER 0.822C) Robotathon shelf! If there are no RAS leaders in the office and you want to do some work on your robot, please reach out to us in the [Robotathon Discord chat](https://discord.com/channels/692834117687181505/881756500933091338)!
+You can store your robot / components on the RAS Office's (EER 0.822C) Robotathon shelf! If there are no RAS leaders in the office and you want to do some work on your robot, please reach out to us in the [Robotathon Discord chat](https://discord.com/channels/692834117687181505/881756500933091338)!
 
-We ask that you keep the robot in the EER at all times to prevent items from getting lost.
+We ask that you keep the robot in the EER at all times to prevent items from getting lost. 
 
-<img src="{{ '/_assets/images/my_image.png' | prepend: site.baseurl }}" alt="my_image.png :(">
-TODO: replace with picture of shelf with designated robotathon robot area
+The designated Robotathon shelf area can be found with all the bags:
+<img src="{{ '/_assets/images/robotathon_shelf.jpg' | prepend: site.baseurl }}" alt="robotathon_shelf.jpg :(">
 
-## What can we keep after the competition?
+<!-- 
 TODO: figure out what they can keep
+## What can we keep after the competition?
+Your team may keep the following:
 - Robot chassis
 - ESP32/all sensors
 
-You must return the following:
-- Remote controller 
+Your team must return the following:
+- Remote controller  -->
diff --git a/docs/_sections/_guide-FAQ/technical.md b/docs/_sections/_guide-FAQ/technical.md
@@ -7,11 +7,11 @@ nav_order: 1
 
 # Technical FAQ
 
-## Why does my build fail?
+<!-- ## Why does my build fail?
 Ensure their portable vscode installation is located in a path without spaces
 Document instance where they have spaces in name
 - Solution is to move project directory to C drive
-TODO: Document reading the error messages (i.e. starting from the first error culprit fixes ones below etc etc)
+TODO: Document reading the error messages (i.e. starting from the first error culprit fixes ones below etc etc) -->
 
 ## What is the difference between cloning using HTTPS and SSH?
 HTTPS (Hypertext Transfer Protocol Secure) and SSH (Secure Shell) are both data transfer protocols used in networking
diff --git a/docs/_sections/_guide-game-overview/game-desc.md b/docs/_sections/_guide-game-overview/game-desc.md
@@ -16,7 +16,7 @@ The competition will be double-elimination style which means if your team is bea
 
 Your team will receive one ping pong ball at the beginning of every round as ammo to destroy the Aggienator
 
-TODO include image of map and have it in its own subcategory
+<!-- TODO include image of map and have it in its own subcategory -->
 
 ## Challenges
 
diff --git a/docs/_sections/_guide-home/docs-dev-setup.md b/docs/_sections/_guide-home/docs-dev-setup.md
@@ -1,11 +1,11 @@
----
+<!-- ---
 layout: default
 title: ROBOTATHON GUIDE JEKYLL SETUP (remove during comp)
 nav_include: true
 nav_order: 1
----
+--- -->
 
-<!-- comment the front matter above when not in dev mode -->
+<!-- comment the front matter above during competition season -->
 
 
 
diff --git a/docs/_sections/_guide-home/docs-syntax.md b/docs/_sections/_guide-home/docs-syntax.md
@@ -1,11 +1,11 @@
----
+<!-- ---
 layout: default
 title: Robotathon GUIDE SYNTAX REFERENCE (remove during comp)
 nav_include: true
 nav_order: 2
----
+--- -->
 
-<!-- comment the front matter above when not in dev mode -->
+<!-- comment the front matter above when in competition season -->
 
 # official syntax docs [https://just-the-docs.com/](https://just-the-docs.com/)
 ^ hyperlinked text example
diff --git a/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling/onshape.md b/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling/onshape.md
@@ -8,7 +8,7 @@ nav_order: 1
 ---
 # 3D Modeling with Onshape
 
-# TODO: finish this page
+<!-- # TODO: finish this page -->
 
 {: .highlight}
 Onshape has excellent documentation on its [help website](https://cad.onshape.com/help/Content/sketch.htm?tocpath=Part%20Studios%7C_____0) (also can be found on the top right corner of your homepage), and should be referenced when you need more detailed help of a specific feature.
@@ -48,7 +48,7 @@ Being organized is the key to reducing hassle while designing, learn the effecti
 
 ### We Thief a bit (sometimes)
 Sometimes you don't want to spend the time modeling something that already exists out on the internet. Aside from [GrabCad](https://grabcad.com/library), you can also get 3D models of parts you need straight in Onshape and quicky model with it.
-TODO: write **or link** a tutorial on how to import models into an onshape project
+<!-- TODO: write **or link** a tutorial on how to import models into an onshape project -->
 
 ### Put it all together!
 Time to see your robot coming together virtually. This step is very important to make sure you don't spend your time making a prototype that you later finds having just that one little dimension that is wrong and rendering the entire thing usable!!! (sometimes recklessly drilling would fix the problem, but we apparently don't recommend that)
diff --git a/docs/_sections/_guide-primaries/getting-started/bluepad.md b/docs/_sections/_guide-primaries/getting-started/bluepad.md
@@ -120,10 +120,10 @@ void loop() {
 }
 ```
 
-TODO: check if we can simplify the above code by removing the for loop
+<!-- TODO: check if we can simplify the above code by removing the for loop
 just hardcode the `myController` pointer to always be myControllers[0]?
 
-TODO: check if the code actually builds lmao
+TODO: check if the code actually builds lmao -->
 
 {: .highlight}
 You **must** call `BP32.update()` to update the current controller values before calling helper functions (i.e. `myController->a()` or `myController->x()`) to actually retrieve the controller values.
diff --git a/docs/_sections/_guide-primaries/getting-started/environment-setup/mac-setup.md b/docs/_sections/_guide-primaries/getting-started/environment-setup/mac-setup.md
@@ -13,8 +13,8 @@ https://docs.espressif.com/projects/vscode-esp-idf-extension/en/latest/installat
 
 
 https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-macos-setup.html
-TODO figure out what to do the setup script installs the CLI for esp-idf isntead of VS Code extension
-proly just gona make them go through the install manually
+<!-- TODO figure out what to do the setup script installs the CLI for esp-idf isntead of VS Code extension
+proly just gona make them go through the install manually -->
 
 ### __Install VSCode__
 Download VSCode from the [online download for Mac](https://code.visualstudio.com/download)
@@ -45,7 +45,8 @@ Note: only **one** person in each team has to fork the repository and invite the
 <img src="{{ '/_assets/images/github_fork.png' | prepend: site.baseurl }}" alt="my_image.png :(">
 1. Change the Repository name to whatever you like
 1. Click the green `Create fork` button at the bottom
-1. Share repository access to your teammates by navigating to the settings of your newly forked repository and clicking collaborators in the left menu [(How do I invite teammates to my forked repository?)](TODO WRITE THIS)
+1. Share repository access to your teammates by navigating to the settings of your newly forked repository and clicking collaborators in the left menu 
+<!-- [(How do I invite teammates to my forked repository?)](TODO WRITE THIS) -->
 
 ### __Set Up Git SSH Authentication__
 
@@ -99,7 +100,8 @@ Cloning is the process of copying a Git repository onto your local computer stor
 1. Click the green `<> Code` button
 1. If you did the previous section, copy the SSH git link. Otherwise copy the HTTPS link. [What is the difference?](https://ut-ras.github.io/RobotathonESP32/technical#what-is-the-difference-between-cloning-using-https-and-ssh)
 <img src="{{ '/_assets/images/ssh_link_copy.png' | prepend: site.baseurl }}" alt="my_image.png w=200 h=400 :(">
-1. Open Git Bash and navigate to where you want to keep your code for the competition, such as your Documents or Desktop. [How do I do that?](TODO write this)
+1. Open Git Bash and navigate to where you want to keep your code for the competition, such as your Documents or Desktop. 
+<!-- [How do I do that?](TODO write this) -->
 1. Run the following command in your Git terminal: `git clone [PASTE GIT LINK HERE]` without the square brackets
 
 ### __Install USB-UART Bridge Driver__
diff --git a/docs/_sections/_guide-primaries/getting-started/environment-setup/windows-setup.md b/docs/_sections/_guide-primaries/getting-started/environment-setup/windows-setup.md
@@ -143,19 +143,17 @@ This **will** take a while if you don't use 7-zip
 
 ### Normal Installation
 1. Download and install [VS Code](https://code.visualstudio.com/download)
-2. Open the extensions tab and search `ESP-IDF`
-TODO put picture
-3. Download the ESP-IDF extension
-TODO put picture
-4. Open the setup wizard by clicking the `Configure Extension` button
-TODO put picture
+2. Open the extensions tab, search `ESP-IDF`, and download the extension
+<img src="{{ '/_assets/images/espidf_extension.png' | prepend: site.baseurl }}" alt="espidf_extension.png :(">
+4. Open the setup wizard by clicking the `Configure Extension` button in the VS Code ESP-IDF welcome page
+<img src="{{ '/_assets/images/espidf_configure.png' | prepend: site.baseurl }}" alt="espidf_configure.png :(">
 5. Click `Express`
-TODO put picture
+<img src="{{ '/_assets/images/espidf_express.png' | prepend: site.baseurl }}" alt="espidf_express.png :(">
 6. Check the box saying `Show all ESP-IDF tags`
-TODO put picture
+<img src="{{ '/_assets/images/espidf_showalltags.png' | prepend: site.baseurl }}" alt="espidf_showalltags.png :(">
 7. Select option `v4.4.8 (release version)`
-TODO put picture
-8. Ensure the installation paths are valid (i.e. no red warnings) and click the blue `Install` button
+<img src="{{ '/_assets/images/espidf_448.png' | prepend: site.baseurl }}" alt="espidf_448.png :(">
+8. Ensure the default installation paths are valid (i.e. no red warnings) and click the blue `Install` button
 9. Wait (this will take a while) :)
 10. In the top menu bar of VS Code, click `File` > `Open Folder`
 11. Use VS Code to open the folder where you cloned the Robotathon repository (“RobotathonESP32” by default)
diff --git a/docs/_sections/_guide-primaries/getting-started/git.md b/docs/_sections/_guide-primaries/getting-started/git.md
@@ -6,8 +6,8 @@ parent: Getting Started
 nav_order: 5
 ---
 
-TODO: add diagram showing a main branch and a feature branch
-TODO: redo diagrams to be accurate and more understandable
+<!-- TODO: add diagram showing a main branch and a feature branch
+TODO: redo diagrams to be accurate and more understandable -->
 
 # How to use Git:
 
diff --git a/docs/_sections/_guide-primaries/getting-started/microcontroller-interface.md b/docs/_sections/_guide-primaries/getting-started/microcontroller-interface.md
@@ -6,7 +6,7 @@ parent: Getting Started
 nav_order: 4
 ---
 
-TODO: elaborate on analog / digital signals
+<!-- TODO: elaborate on analog / digital signals -->
 
 
 # Microcontroller Interfacing
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/ir-sensors.md b/docs/_sections/_guide-primaries/sensors-and-actuators/ir-sensors.md
@@ -57,8 +57,3 @@ void loop() {
 }
 ```
 
-## Extensions
-You received values from the sensor, but what do they mean? The next step for the IR sensor is translating and thresholding it. Take a look at the above graph. There is a strong linear relationship between your signal value and the distance away from the object. It’s your job now to code a function that returns an accurate distance given a voltage input value. After that, your team needs to threshold the data. When do the values become inconsistent (too close or too far)? What do you do with your robot when that happens?
-
-TODO review this extension thing and see if we want to make them actually calculate distance
-
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/line-sensors.md b/docs/_sections/_guide-primaries/sensors-and-actuators/line-sensors.md
@@ -29,7 +29,7 @@ This side of the sensor will be facing the floor to detect the line:
 Keep in mind that the QTR line sensor has two 5V pins that are connected to each other! They are identical in function besides being in a different location
 {: .callout-blue}
 
-TODO add picture of backside pinout with labels
+<!-- TODO add picture of backside pinout with labels -->
 
 <img src="{{ '/_assets/images/line_sensor_wire_diagram.png' | prepend: site.baseurl }}" alt="line_sensor_wire_diagram.png">
 
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/power.md b/docs/_sections/_guide-primaries/sensors-and-actuators/power.md
@@ -1,12 +1,12 @@
----
+<!-- ---
 layout: default
 title: Powering the System
 nav_include: true
 parent: Hardware
 nav_order: 1
----
+--- -->
 
-TODO write this
+<!-- TODO write this -->
 
 
 - How do basic circuits work? (i.e. current only flows in a closed loop, what is voltage, what is ground, etc.)
diff --git a/docs/_sections/_guide-supplementals/breadboard-bugs.md b/docs/_sections/_guide-supplementals/breadboard-bugs.md
@@ -1,27 +1,32 @@
----
+<!-- ---
 layout: default
 title: Debugging
 nav_include: true
 # parent: Resources
 nav_order: 2
----
+--- -->
+
+<!-- TODO add to this section and maybe remove the bottom "How to avoid a short circuit bc its kinda useless for the comp. if anything just integrate some of the tips into hardware bugs? -->
 
 # Debugging
 
 Things aren't working? Chances are it's because of something super silly like an unplugged wire or off by one error.
 
 ## Software Bugs
 
-TODO make checklist
+1. Do you have any unintentional infinite loops?
+1. Are you calling `vTaskDelay(1)` in your main loop to reset the watchdog timer? (included in sample code)
+1.
 
 
 ## Hardware Bugs
 
-TODO finish checklist
+<!-- TODO finish checklist -->
 1. Is everything plugged in properly?
     * Did you double check?
 1. If the issue is with your color sensor, did you have the SDA and SCL lines flipped?
 1. Did you try using a multimeter to diagnose the issue?
+1. Did you try another sensor if the current one you are trying doesn't work?
 
 ### What is a short circuit?
 
@@ -35,7 +40,7 @@ A short circuit causes a surge of high amounts of current to flow through both n
  * Do not have microcontroller connected to power when moving around cables
 * Make sure that there are no open cables  near an electronic device with power.
 * Make sure to not connect cables to the wrong pins.
- * I.e. you should never directly connect VCC to GND with no resistance in between. 
+ * i.e. you should never directly connect VCC to GND with no resistance in between. 
 * Make sure to connect resistors of the necessary resistance to any electronic devices you will interface with.
  * Not doing so will a high amount of current through the electronic device and potentially damage it (or make it burst into flames)
 * Don’t touch an electronic part with a metal
