- Fixed commented lines breaking imports in the config file

- Added nested subsections in the left sidebar for the categories
ut-ras · Jun 29, 2024 · 3e8d4ec · 3e8d4ec
1 parent 5d91d8b
commit 3e8d4ec
Show file tree

Hide file tree

Showing 29 changed files with 176 additions and 7 deletions.
diff --git a/docs/_assets/css/picture.png b/docs/_assets/css/picture.png
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -24,7 +24,7 @@ description: >- # this means to ignore newlines until "baseurl:"
   Write an awesome description for your new site here. You can edit this
   line in _config.yml. It will appear in your document head meta (for
   Google search results) and in your feed.xml site description.
-baseurl: "/RobotathonESP32" # the subpath of your site, e.g. /blog
+baseurl: "/docs" # the subpath of your site, e.g. /blog
 url: "https://ut.ieee.ras.github.io" # the base hostname & protocol for your site, e.g. http://example.com
 
 # Build settings
@@ -52,7 +52,7 @@ exclude:
 
 # Include files despite having a preceding underscore in directory name
 include:
-  # - _assets # Example of including _assets directory
+  - _assets # Example of including _assets directory
 
 # Collections for website data
 collections_dir: _sections

diff --git a/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling.md b/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: 3D Modeling
+nav_include: true
+parent: Designing a Robot
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/designing-a-robot/constructing-chassis.md b/docs/_sections/_guide-primaries/designing-a-robot/constructing-chassis.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Chassis Construction
+nav_include: true
+parent: Designing a Robot
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/designing-a-robot/designing-a-robot.md b/docs/_sections/_guide-primaries/designing-a-robot/designing-a-robot.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Designing a Robot
+nav_include: true
+has_children: true
+nav_order: 2
+---
diff --git a/docs/_sections/_guide-primaries/designing-a-robot/drive-system.md b/docs/_sections/_guide-primaries/designing-a-robot/drive-system.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Drive System
+nav_include: true
+parent: Designing a Robot
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/designing-a-robot/sensor-and-actuator-placement.md b/docs/_sections/_guide-primaries/designing-a-robot/sensor-and-actuator-placement.md
@@ -0,0 +1,22 @@
+---
+layout: default
+title: Sensor and Actuator Placement
+nav_include: true
+parent: Designing a Robot
+nav_order: 1
+---
+
+<img src="{{ '/_assets/images/picture.png' | prepend: site.baseurl }}" alt="4 :(">
+
+<!-- <img src="
+petition to change this section's title to "Component Placement" -->
+
+lorem ipsum here is some text
+When designing and building your robot you need to think about the placement of your sensors!
+Distance (IR) Sensor:
+The distance sensor will be used during the wall following portion of the competition. The location of the distance sensor can affect your chassis design and code so it is important to decide on a good location!! Also remember that you have more than one IR sensor available to you so use this to your advantage. Below are some different ideas:
+aaaaa
+Line Sensor and Color Sensor:
+These two sensors will have similar placement! The line sensor and color sensor will be used to to detect what is right underneath the robot so these two will be placed on the bottom of your robot. Make sure your sensors are very close to the ground in order for them to function properly!! Below are some diagrams and pictures to help you visualize this:
+
+Since your sensors need to be very close to the ground you should consider how you will be building the chassis of your robot and how you will attach these sensors. Your wheels will add some height to your chassis so you might have to add some form of support to the bottom in order to hold your sensors close to the ground.
diff --git a/docs/_sections/_guide-primaries/getting-started/environment-setup.md b/docs/_sections/_guide-primaries/getting-started/environment-setup.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Environment Setup
+nav_include: true
+parent: Getting Started
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/getting-started/getting-started.md b/docs/_sections/_guide-primaries/getting-started/getting-started.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Getting Started
+nav_include: true
+has_children: true
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/getting-started/microcontroller-interface.md b/docs/_sections/_guide-primaries/getting-started/microcontroller-interface.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Microcontroller Interface
+nav_include: true
+parent: Getting Started
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/getting-started/reading-datasheets.md b/docs/_sections/_guide-primaries/getting-started/reading-datasheets.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Reading Datasheets
+nav_include: true
+parent: Getting Started
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/guide-manual.md b/docs/_sections/_guide-primaries/guide-manual.md
@@ -1,4 +1,8 @@
 ---
 layout: default
-title:
+title: How to read :D (idk what to name this)
+nav_order: 0
 ---
+
+
+ooga booga
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/color-sensors.md b/docs/_sections/_guide-primaries/sensors-and-actuators/color-sensors.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Color Sensor
+nav_include: true
+parent: Sensors and Actuators
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/ir-sensors.md b/docs/_sections/_guide-primaries/sensors-and-actuators/ir-sensors.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: IR Sensor
+nav_include: true
+parent: Sensors and Actuators
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/line-sensors.md b/docs/_sections/_guide-primaries/sensors-and-actuators/line-sensors.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Line Sensor
+nav_include: true
+parent: Sensors and Actuators
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/motors.md b/docs/_sections/_guide-primaries/sensors-and-actuators/motors.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Motors
+nav_include: true
+parent: Sensors and Actuators
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/pid-control.md b/docs/_sections/_guide-primaries/sensors-and-actuators/pid-control.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: PID Control
+nav_include: true
+parent: Sensors and Actuators
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/sensor-integration.md b/docs/_sections/_guide-primaries/sensors-and-actuators/sensor-integration.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Sensor Integration
+nav_include: true
+parent: Sensors and Actuators
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-primaries/sensors-and-actuators/sensors-and-actuators.md b/docs/_sections/_guide-primaries/sensors-and-actuators/sensors-and-actuators.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Sensors and Actuators
+nav_include: true
+has_children: true
+nav_order: 3
+---
diff --git a/docs/_sections/_guide-supplementals/breadboard-bugs.md b/docs/_sections/_guide-supplementals/breadboard-bugs.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Breadboard Bugs
+nav_include: true
+# parent: Resources
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-supplementals/debugging/breadboard-bugs.md b/docs/_sections/_guide-supplementals/debugging/breadboard-bugs.md
diff --git a/docs/_sections/_guide-supplementals/debugging/scopes.md b/docs/_sections/_guide-supplementals/debugging/scopes.md
diff --git a/docs/_sections/_guide-supplementals/design-for-manufacturing.md b/docs/_sections/_guide-supplementals/design-for-manufacturing.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Manufacturing
+nav_include: true
+# parent: Resources
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-supplementals/guide-supplementals.md b/docs/_sections/_guide-supplementals/guide-supplementals.md
@@ -0,0 +1,7 @@
+<!-- ---
+layout: default
+title: Resources
+nav_include: true
+has_children: true
+nav_order: 1
+--- -->
diff --git a/docs/_sections/_guide-supplementals/mechanical-design/design-for-manufacturing.md b/docs/_sections/_guide-supplementals/mechanical-design/design-for-manufacturing.md
diff --git a/docs/_sections/_guide-supplementals/scopes.md b/docs/_sections/_guide-supplementals/scopes.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Scopes
+nav_include: true
+# parent: Resources
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-supplementals/software.md b/docs/_sections/_guide-supplementals/software.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Software (??)
+nav_include: true
+# parent: Resources
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-supplementals/tuning-ir-sensors.md b/docs/_sections/_guide-supplementals/tuning-ir-sensors.md
@@ -0,0 +1,7 @@
+---
+layout: default
+title: Tuning IR Sensors
+nav_include: true
+# parent: Resources
+nav_order: 1
+---
diff --git a/docs/_sections/_guide-supplementals/tuning/tuning-ir-sensors.md b/docs/_sections/_guide-supplementals/tuning/tuning-ir-sensors.md