Skip to content

Commit ddeb762

Browse files
committed
proofreading + updated TODO
1 parent 090d2c8 commit ddeb762

File tree

14 files changed

+19
-16
lines changed

14 files changed

+19
-16
lines changed

docs/_sections/_guide-home/forms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ nav_include: true
55
nav_order: 5
66
---
77

8-
# Links and Formsaaa
8+
# Links and Forms
99

1010
This page contains direct links and forms that you might need for Robotathon!
1111

docs/_sections/_guide-home/schedule.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@ nav_order: 4
88
# Competition Schedule
99

1010
This calendar will have the most up to date version of the competition timeline!
11-
<iframe src="https://calendar.google.com/calendar/embed?src=1e8b00794a07180514fdc54c5b78dca70637bc1a8a72076e64dc787ebe2a71cb%40group.calendar.google.com&ctz=America%2FChicago" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe>
11+
<iframe src="https://calendar.google.com/calendar/embed?src=9a08dd3dac1df5c210999c130b7e69ccc35d1f88f91902aa3ff64ee9daa4aa3b%40group.calendar.google.com&ctz=America%2FChicago" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe>
1212

1313
{: .highlight}
1414
Tip: You can add this calendar to your personal Google calendar by clicking the plus button above^^
1515
{: .callout-blue}
1616

17-
Here is the [RAS office hours schedule](https://docs.google.com/spreadsheets/d/1MNuk1WAB5ZmVcOo-_wdnVN3yREhI9oH90169OuW2QAc/edit?gid=1317822740#gid=1317822740) You may go to any of the office hours that you please, but note that office hours are subject to change throughout the semester.
17+
Here is the [RAS office hours schedule](https://docs.google.com/spreadsheets/d/132Lb-cNybgYhRVPhrrf0xoe3HGi9ErQ2J2lOkMYBeXc/edit?gid=0#gid=0) You may go to any of the office hours that you please, but note that office hours are subject to change throughout the semester.

docs/_sections/_guide-home/welcome.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ nav_order: 3
1414

1515
This guide aims to provide you with helpful information and direction throughout your robot building process. While this guide is broad, it stays mostly within the realm of setup and basic tips since we encourage you to discover your own solutions.
1616

17-
If you have any technical questions or don’t understand a topic, ask the mentors or during [TODO: link office hours here]()! We can help to resolve your problems, or point you to the right person who can. Mentors, office hours, and other teammates are valuable resources to turn to if you are stuck.
17+
If you have any technical questions or don’t understand a topic, ask the mentors during [office hours](https://docs.google.com/spreadsheets/d/132Lb-cNybgYhRVPhrrf0xoe3HGi9ErQ2J2lOkMYBeXc/edit?gid=0#gid=0)! We can help to resolve your problems, or point you to the right person who can. Mentors, office hours, and other teammates are valuable resources to turn to if you are stuck.
1818

1919
## Overview
2020

docs/_sections/_guide-primaries/designing-a-robot/designing-a-robot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ nav_include: true
55
has_children: true
66
nav_order: 3
77
---
8-
8+
# How do I put it all together?
99
<!-- this file is for the section drop down bar -->

docs/_sections/_guide-primaries/designing-a-robot/sensor-and-actuator-placement.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ Illustrated below is a sample configuration:
3232
<img src="{{ '/_assets/images/line_and_color.png' | prepend: site.baseurl }}" alt="line_and_color.png :(" >
3333

3434
## Actuators
35-
"Actuators" is just a fancy name for motors or anything that enables some kind of 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, (arguably) most importantly, turns.
35+
"Actuators" is just a fancy name for motors or anything that enables some kind of movement for your robot. You will need at least two of these with a caster 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, (arguably) most importantly, turns.
3636

docs/_sections/_guide-primaries/getting-started/bluepad.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 6
1010

1111
You will be connecting a game controller to your ESP32 for controlling your robot (i.e. triggering autonomous modes, moving between challenges, and firing your launching mechanism)
1212

13-
That being said, you will not be allowed to manually drive your robot through the challenges, as that defeats the purpose of having the sensors.
13+
That being said, you will not earn points for manually driving your robot through the challenges, as that defeats the purpose of having the sensors.
1414

1515
It is highly recommended that you program specific functions of the sensors (line, color, distance) to specific buttons on the remote controller so that you have more control over your robot's behavior (i.e. press A -> color autonomy mode, press B -> exit to normal drive mode).
1616

docs/_sections/_guide-primaries/getting-started/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,5 @@ nav_include: true
55
has_children: true
66
nav_order: 2
77
---
8-
8+
# How do I get started on my robot?
99
<!-- this file is for the section drop down bar -->

docs/_sections/_guide-primaries/getting-started/git.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ parent: Getting Started
66
nav_order: 5
77
---
88

9-
# How to use Git
9+
# How to use Git:
1010

1111
## What is Git?
1212
**Git** is a tool used for source/version control, which is the process of tracking changes to files over time.
@@ -33,7 +33,10 @@ Note that Robotathon aims to give you a *basic* understanding of how Git/GitHub
3333
1. Run `git commit -m "message here"` (keep quotes) to **commit** your change to your *local* repository [(What is the `-m`?)](todo LINK to how to use git bash in faq)
3434
1. Run `git push` to write your changes to the *remote* repository on GitHub
3535

36+
37+
{: .highlight}
3638
TODO add picture
39+
{: .callout-red}
3740

3841
## What is staging in Git?
3942
Instead of having to push every little change to your repository, you can group them into a collection of changes called a **commit**, which serve as a snapshot of the project's state.

docs/_sections/_guide-primaries/getting-started/microcontroller-interface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ We are only concerned with pins that are power, ground, GPIO, and ADC enabled, s
2121
* ADC (Analog to Digital Converter) - only some pins. These pins can read analog values instead of just high or low.
2222

2323
{: .highlight}
24-
Warning: Be careful to not short (connect) a power pin directly to a ground pin. This will fry your ESP32 and more by causing a huge surge of current.
25-
{: .callout-blue}
24+
Warning: Be careful to not short (connect) a power pin directly to a ground pin. This will fry your ESP32 and more by causing a huge surge of current (not good).
25+
{: .callout-red}
2626

2727
## Powering the ESP32
2828
You can power your ESP32 by 2 methods: battery pack or laptop USB connection.

docs/_sections/_guide-primaries/sensors-and-actuators/actuators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Again, more detailed information about the L298N motor controllers can be [found
109109

110110
## What Are Servos?
111111

112-
Servos are motors that are designed for precise position control. Instead of freely rotating when powered, servos listen to a control signal (usually [PWM](https://learn.sparkfun.com/tutorials/pulse-width-modulation/all)) to determine where to rotate. Some servos offer limited rotation, while others can rotate continuously (like ours).More advanced servos have other ways to be even more precise such as a feedback system on top of the control signal, but that is not necessary for this competition.
112+
Servos are motors that are designed for precise position control. Instead of freely rotating when powered, servos listen to a control signal (usually [PWM](https://learn.sparkfun.com/tutorials/pulse-width-modulation/all)) to determine where to rotate. Some servos offer limited rotation, while others can rotate continuously (like ours). More advanced servos have other ways to be even more precise such as a feedback system on top of the control signal, but that is not necessary for this competition.
113113

114114
## How to Use Servos?
115115

0 commit comments

Comments
 (0)