Changed nesting scheme on left sidebar. Added docs/_includes to use f…

…avicon (small website tab icon)
ut-ras · Jun 29, 2024 · 204f59c · 204f59c
1 parent 3e8d4ec
commit 204f59c
Show file tree

Hide file tree

Showing 14 changed files with 73 additions and 23 deletions.
diff --git a/docs/_assets/css/picture.png b/docs/_assets/css/picture.png
diff --git a/docs/_assets/images/picture.png b/docs/_assets/images/picture.png
diff --git a/docs/_assets/images/rasterchef.ico b/docs/_assets/images/rasterchef.ico
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -18,12 +18,10 @@
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
 
-title: Robotathon 
+title: Robotathon Docs
 email: [email protected]
 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: "/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
 
@@ -72,14 +70,17 @@ collections:
 just_the_docs:
   collections:
     guide-general:
-      name: "Home"
+      name: Home
       nav_fold: false
     guide-primaries:
       name: Newbie Guide
-      nav_fold: true
+      nav_fold: false
     guide-supplementals:
       name: Resources
-      nav_fold: true
+      nav_fold: false
 
 # Define default color scheme
 color_scheme: custom-light
+
+# Website Icon
+# favicon.ico: "_assets/images/favicon.ico" #idk why this doesnt work lol
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>{{ page.title | default: site.title }}</title>
+    <!-- Favicon -->
+    <link rel="icon" href="{{ '/_assets/images/rasterchef.ico' | relative_url }}" type="image/x-icon">    <!-- Stylesheets -->
+    {% if site.color_scheme == 'custom-light' %}
+    <link rel="stylesheet" href="{{ '/_assets/css/just-the-docs-custom-light.css' | relative_url }}">
+    {% else %}
+    <link rel="stylesheet" href="{{ '/_assets/css/just-the-docs-custom-dark.css'' | relative_url }}"> 
+    <!--  lol -->
+    {% endif %}
+</head>
+<body>
diff --git a/docs/_layouts/home.html b/docs/_layouts/home.html
@@ -3,3 +3,4 @@
 ---
 
 {{ content }}
+home test text
diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss
@@ -2,3 +2,13 @@
 // Additionally, you may want to add completely custom CSS specific to your content
 // To do this, put your styles in the file _sass/custom/custom.scss
 // This will allow for all overrides to be kept in a single file, and for any upstream changes to still be applied
+
+
+.callout-toby {
+    background-color: #F8F8F0; 
+    border-left: 5px solid #66D9EF;
+    border-radius: 5px; // rounded edge
+    padding: 0.5rem; // left side padding
+    margin-top: .4rem; 
+    margin-bottom: .4rem; 
+  }
diff --git a/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling.md b/docs/_sections/_guide-primaries/designing-a-robot/3d-modeling.md
@@ -3,5 +3,5 @@ layout: default
 title: 3D Modeling
 nav_include: true
 parent: Designing a Robot
-nav_order: 1
+nav_order: 3
 ---
diff --git a/docs/_sections/_guide-primaries/designing-a-robot/constructing-chassis.md b/docs/_sections/_guide-primaries/designing-a-robot/constructing-chassis.md
@@ -3,5 +3,5 @@ layout: default
 title: Chassis Construction
 nav_include: true
 parent: Designing a Robot
-nav_order: 1
+nav_order: 4
 ---
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
@@ -3,5 +3,5 @@ layout: default
 title: Designing a Robot
 nav_include: true
 has_children: true
-nav_order: 2
+nav_order: 3
 ---
diff --git a/docs/_sections/_guide-primaries/designing-a-robot/drive-system.md b/docs/_sections/_guide-primaries/designing-a-robot/drive-system.md
@@ -3,5 +3,5 @@ layout: default
 title: Drive System
 nav_include: true
 parent: Designing a Robot
-nav_order: 1
+nav_order: 2
 ---
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
@@ -6,17 +6,39 @@ 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" -->
+# lowk what if i just dont do pictures and let them figure it out
+# Sensor and Actuator Placement
+
+During the design process you will need to carefully plan your sensor and actuator placement as it will drastically shape your robot! This section will give a brief overview of some things to consider during this part of the design process.
+
+## Infrared (IR) Distance Sensor
+The distance sensor will be used during the wall following portion of the competition. The location of the distance sensors *will* affect your chassis design and code so it is important to decide on a good location! Also remember that you should include multiple IR sensors in your design.
+
+{: .highlight}
+Remember that the (insert sensor model here) has a specific range (link to datasheet) that produces good output, so place your IR sensors accordingly!
+{: .callout-toby}
 
-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:
+Below are some different ideas of placement:
+pictures
+
+## 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!
+
+However, a common issue with the color sensor is that there is not enough neutral (white) light to get an accurate reading. One way to get around this is to use a white LED to illuminate the area to be scanned.
 
 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.
+
+Below are some diagrams and pictures to help you visualize this:
+pictures
+
+## Actuators
+"Actuators" is just a fancy name for motors or anything that enables movement for your robot. You will need at least two of these with a castor ball to have a moving base. While you have full creative reign on where to put your actuators to achieve motion and solve the mechanical challenge, it will be important to consider where to place your wheel actuators since they will affect how your robot drives and most importantly turns.
+
+
+<img src="{{ '/_assets/images/picture.png' | prepend: site.baseurl }}" alt="4 :(">
+
+<img src="{{ '/_assets/images/picture.png' | relative_url }}" alt="1 :(">
+
+<img src="/docs/_assets/images/picture.png" alt="2 :(">
+
diff --git a/docs/_sections/_guide-primaries/guide-manual.md b/docs/_sections/_guide-primaries/guide-manual.md
@@ -5,4 +5,4 @@ nav_order: 0
 ---
 
 
-ooga booga
+can we kill this file/merge it to Getting Started
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
@@ -3,5 +3,5 @@ layout: default
 title: Sensors and Actuators
 nav_include: true
 has_children: true
-nav_order: 3
+nav_order: 2
 ---
Original file line number	Diff line number	Diff line change
Expand Up		@@ -5,4 +5,4 @@ nav_order: 0
		---


		ooga booga
		can we kill this file/merge it to Getting Started