Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Grammer changes #18

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Toggling 12v and5v power
title: Toggling 12v and 5v power
category: Programming
sidebar:
order: 10
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/tools/connecting.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar:
order: 1
---

1. Turn on the robot by following the instructions [here](/tutorials/turning-everything-on.md).
1. Turn on the robot by following the instructions [here](/tutorials/turning-everything-on).
2. Turn on your computer and wait until you reach the Windows desktop.
3. Click on the WiFi icon in the bottom right and connect to `RoboConYYYY-TeamXX` where `YYYY` is the competition year and `XX` is your team number. Your WiFi password should be on the bottom of your BrainBox, underneath its network name.
4. Navigate to <http://robot.local> in your web browser of choice (**Chrome** or **Firefox** is recommended). You should see an interface similar to this:
Expand All @@ -16,5 +16,5 @@ From now on, this will be referred to as the **Shepherd Homepage**.

## Next Steps

- [Learn to use the editor](/tools/editor.md) right here in the browser!
- [Troubleshooting](/tools/troubleshooting.md)
- [Learn to use the editor](/tools/editor) right here in the browser!
- [Troubleshooting](/tools/troubleshooting)
4 changes: 2 additions & 2 deletions src/content/docs/tools/editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar:
---
We recommend you use the code editor that's included with Shepherd to program your robot. You can either program in Python or use Blockly, a powerful Scratch-like programming tool.

Assuming you've [connected to your robot](/tools/connecting.md), head to <http://robot.local/editor> or click the orange
Assuming you've [connected to your robot](/tools/connecting), head to <http://robot.local/editor> or click the orange
editor button on the Shepherd homepage.

![Upload Button](/images/shepherd-editor.png)
Expand Down Expand Up @@ -56,7 +56,7 @@ The create project dialog will appear:
Give your project a name, then select the type of project you would like. Choose either Python or Blockly. Then click the **create** button.

Your new project will open in the editor. See the sections below for more information on [Python](#python-projects) and
[Blockly](#blockly-projects) projects. Once you've read these, why not start learning [how to program your robot](/programming/init-robot.md).
[Blockly](#blockly-projects) projects. Once you've read these, why not start learning [how to program your robot](/programming/init-robot).

## Python Projects

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/tools/running-code-from-a-usb.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ When started, using the start button the robot will default to running the last
4. Press the black start button

:::caution
Code copied from USB sticks is not [Linted](https://en.wikipedia.org/wiki/Lint_%28software%29), sufficiently broken code may crash not just the user code, but also the web interface preventing the robot from reaching "Blinky". See [troubleshooting](/troubleshooting.html#troubleshooting) for details about what the LEDs mean. It is highly recommended for users to export working code from the editor to the USB stick rather than editing code directly. See [troubleshooting](/troubleshooting.html#the-brainbox-appears-to-power-up-but-i-can-t-connect-to-the-website-and-the-blue-led-lights-but-never-starts-flashing) for how to recover a robot which does not boot to Blinky.
Code copied from USB sticks is not [Linted](https://en.wikipedia.org/wiki/Lint_%28software%29), sufficiently broken code may crash not just the user code, but also the web interface preventing the robot from reaching "Blinky". See [troubleshooting](/tools/troubleshooting.html#troubleshooting) for details about what the LEDs mean. It is highly recommended for users to export working code from the editor to the USB stick rather than editing code directly. See [troubleshooting](/tools/troubleshooting.html#the-brainbox-appears-to-power-up-but-i-can-t-connect-to-the-website-and-the-blue-led-lights-but-never-starts-flashing) for how to recover a robot which does not boot to Blinky.

:::

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/tools/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Calling `R.see()` at a high rate (with a sleep of less than 2 seconds between ea

## Can you post a kit to or from Hills Road

We can post kits from Hills Road however you will need to cover the costs of shipping. To return kits, see [Kit List of Parts](/hardware/kit-list-of-parts)
We can post kits from Hills Road however you will need to cover the costs of shipping. To return kits, see [Kit List of Parts](/hardware/kit-list-of-parts).

## What is the patch and how do I install it?

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/tutorials/hello-gpio.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ while True:

Note that `INPUT_PULLUP` returns inverted values - `True` when it isn't pressed and `False` when it is. This means we use `not` to invert the output we get back to something more sensible for our use.

Try making a light turn on or off depending on if a button is pressed. An explanation of why it is needed to use `INPUT_PULLUP` can be found in the [GPIO documentation](/gpio/#pull-ups).
Try making a light turn on or off depending on if a button is pressed. An explanation of why it is needed to use `INPUT_PULLUP` can be found in the [GPIO documentation](/programming/gpio/#pull-ups).

## Potentiometers

Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/tutorials/hello-motors.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ R.motors[1] = 0
A final note, even if you set both motors the same power, your robot probably won't drive in a perfectly straight line. This is due to defects in the motors, and unless you get specialised motors, no two motors will have the same offset. How your robot deals with this is up to you!

## Troubleshooting and Further Reading
[Connecting to the robot](/connecting.html) <br>
[Uploading and running code](/uploading.html) <br>
[Using the editor](/editor.html) <br>
[Motors](/motors.html)
[Connecting to the robot](/tools/connecting) <br>
[Uploading and running code](/tools/uploading) <br>
[Using the editor](/tools/editor) <br>
[Motors](/programming/motors)
2 changes: 1 addition & 1 deletion src/content/docs/tutorials/hello-vision.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Your robot can use its camera to see markers to identify tokens and walls. This

Create a new script called "VisionTest".

Unlike in the previous tutorial, [Hello World](/challenges/hello-world), the use of the first couple lines of code is important here. So let's break them down:
Unlike in the previous tutorial, [Hello World](/tutorials/hello-world), the use of the first couple lines of code is important here. So let's break them down:

```python
import robot
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/tutorials/turning-everything-on.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The BrainBox is the core of the kit which we provide. In it is all of the electr

![Diagram showing the pinout of the top of the BrainBox](/images/BrainBox%20power%20input%20side%20profile%20labelled.png)

Pressing the start button will cause the blue status LED on the front of the BrainBox to turn on. When the light starts flashing your BrainBox is ready to run code. You can now turn on your tablet by pressing the power button on the left-hand side and [connect to your robot](/connecting.md). The status LED will go solid while code is running.
Pressing the start button will cause the blue status LED on the front of the BrainBox to turn on. When the light starts flashing your BrainBox is ready to run code. You can now turn on your tablet by pressing the power button on the left-hand side and [connect to your robot](/tools/connecting). The status LED will go solid while code is running.

# How to turn everything off

Expand Down