Adding troubleshooting notes and rearranging pages

SparkFun-Documentation-Team · SparkFun-Documentation-Team · commit 80dca5ab1755 · 2024-05-28T08:42:07.000-06:00
diff --git a/README.md b/README.md
@@ -18,8 +18,8 @@ Repository Contents
 
 Documentation
 --------------
-* **[Library](https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library)** - Arduino library for the SparkFun Optical Tracking Odometry Sensor.
-* **[Hookup Guide](https://docs.sparkfun.com/SparkFun_Optical_Tracking_Odometry_Sensor/)** - Basic hookup guide for the SparkFun Optical Tracking Odometry Sensor.
+* **[Arduino Library](https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library)** - Arduino library for the SparkFun Optical Tracking Odometry Sensor.
+* **[Hookup Guide](https://docs.sparkfun.com/SparkFun_Optical_Tracking_Odometry_Sensor/)** - Hookup guide for the SparkFun Optical Tracking Odometry Sensor.
 
 
 License Information
diff --git a/docs/assets/img/SEN-24904-Action-GIF-1.gif b/docs/assets/img/SEN-24904-Action-GIF-1.gif
diff --git a/docs/assets/img/SEN-24904-Action-GIF-2.gif b/docs/assets/img/SEN-24904-Action-GIF-2.gif
diff --git a/docs/examples.md b/docs/examples.md
@@ -170,7 +170,7 @@ If the sensor is mounted 5 inches to the left (negative X) and 10 inches forward
 </figure>
 
 
-
+These four examples cover the basics - there are more examples to explore in the library! 
 
 
 
diff --git a/docs/single_page.md b/docs/single_page.md
@@ -18,7 +18,7 @@ icon: fontawesome/solid/scroll
 --8<-- "./docs/hardware_assembly_FTC.md:5"
 
 ## Software Setup
---8<-- "./docs/software_setup_and_programming.md:5"
+--8<-- "./docs/software_setup-Arduino.md:5"
 
 # Troubleshooting Tips
 --8<-- "./docs/troubleshooting.md:5"
diff --git a/docs/software_setup-Arduino.md b/docs/software_setup-Arduino.md
@@ -14,21 +14,3 @@ We've written a library to get you started with the SparkFun Optical Tracking Od
 </center>
 
 
-
-
-<!--
-## Python
-
-
-Arduino library
-
-
-Python Library
-
-Java library - for robotics
-
-
-Do we need to do calibration? Maybe
-
-
--->
diff --git a/docs/software_setup-Python.md b/docs/software_setup-Python.md
@@ -0,0 +1,16 @@
+---
+icon: simple/python
+---
+
+## Python
+
+!!! attention
+	If this is your first time using Arduino, please review our tutorial on [installing the Arduino IDE](https://learn.sparkfun.com/tutorials/installing-arduino-ide). If you have not previously installed an Arduino library, please check out our [installation guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library).
+
+We've written a library to get you started with the SparkFun Optical Tracking Odometry Sensor. You can obtain this library through the Arduino Library Manager by searching for "Odometry" and installing the latest version from SparkFun. If you prefer downloading libraries manually, you can grab them from the GitHub Repository.
+
+<center>
+	[SparkFun Optical Tracking Odometry Sensor Arduino Library GitHub](https://github.com/sparkfun/SparkFun_Qwiic_OTOS_Arduino_Library/archive/refs/heads/main.zip){ .md-button .md-button--primary }
+</center>
+
+
diff --git a/docs/troubleshooting.md b/docs/troubleshooting.md
@@ -2,6 +2,19 @@
 icon: fontawesome/solid/question
 ---
 
+A few things we've noticed: 
+
+
+## Calibration
+
+Got the spins? If the IMU isn't calibrated correctly, the gyroscope will think the robot is constantly rotating and you may see something like below. If you find this, try re-calibrating your bot. 
+
+<figure markdown>
+[![You spin me right round baby right round](assets/img/SEN-24904-Action-GIF-2.gif){ width="600" }](assets/img/SEN-24904-Action-GIF-2.gif "Click to enlarge")
+<figcaption markdown>Example of Calibration Error</figcaption>
+</figure>
+
+
 
 !!! note
     <span class="glyphicon glyphicon-question-sign" aria-hidden="true"></span>
@@ -14,3 +27,5 @@ icon: fontawesome/solid/question
     If you don't find what you need there, the <a href="https://forum.sparkfun.com/index.php">SparkFun Forums</a> are a great place to find and ask for help. If this is your first visit, you'll need to <a href="https://forum.sparkfun.com/ucp.php?mode=register">create a Forum Account</a> to search product forums and post questions.<br /><br />
 
     <div style="text-align: center"><a href="https://forum.sparkfun.com/ucp.php?mode=register" class="md-button">Create New Forum Account</a>&nbsp;&nbsp;&nbsp;<a href="https://forum.sparkfun.com/index.php" class="md-button md-button--primary">Log Into SparkFun Forums</a></div>
+
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -256,7 +256,10 @@ nav:
     - Hardware Assembly: 
       - XRP: hardware_assembly.md
       - FTC: hardware_assembly_FTC.md
-    - Software Setup: software_setup_and_programming.md
+    - Software Setup: 
+      - Arduino: software_setup-Arduino.md
+#      - Python: software_setup-Python.md
+#     - FIRST Tech Challenge: 
     - Examples: 
       - Arduino Examples: examples.md
 #     - Python Examples: 

Original file line number	Diff line number	Diff line change
`@@ -170,7 +170,7 @@ If the sensor is mounted 5 inches to the left (negative X) and 10 inches forward`
`170`	`170`	`</figure>`
`171`	`171`
`172`	`172`
`173`		`-`
	`173`	`+These four examples cover the basics - there are more examples to explore in the library!`
`174`	`174`
`175`	`175`
`176`	`176`