Skip to content

Commit 77dc7ad

Browse files
authored
SR2024 - Update Section - Introduction
2 parents 41f0f40 + 9ddbebe commit 77dc7ad

File tree

1 file changed

+18
-15
lines changed

1 file changed

+18
-15
lines changed

index.md

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,33 @@ title: Documentation
66
Introduction
77
============
88

9-
There are a number of sections in the documentation,
10-
offering help for the [kit](/docs/kit/) and [programming](/docs/programming/).
11-
Under the [tutorials](/docs/tutorials/) section,
12-
a number of these things are combined to help you understand what you can,
13-
or need, to do.
14-
Navigation of the documentation can be done using the column to the left,
15-
where everything is arranged alphabetically in the aforementioned sub-sections.
9+
This documentation explains how to use the kit and the robot's Python API.
10+
The information is spread across multiple sections:
1611

12+
- The [kit](/docs/kit/) section will give you an overview of the physical kit that is provided to your team, how to connect to each board and what features they have.
13+
- The [programming](/docs/programming/) section talks through how to write code that interacts with all the boards.
14+
- The [rules](/docs/rules/) section is important as it talks through the aim of this year's game and what task you are trying to achieve.
15+
- [Tutorials](/docs/tutorials/) are a series of guides that will help you get started.
1716

1817
Within this documentation, you will come across a number of boxes like this:
1918

2019
~~~~~ python
2120
# code example
2221
~~~~~
2322

24-
These are code examples provided to help you.
23+
These are pieces of example code that you can run on your robot.
2524

26-
From time to time,
27-
you may come across some warnings such as the following:
25+
From time to time, you may come across some warnings such as the following:
2826

29-
<div class="warning">Charge Your Batteries!</div>
27+
<div class="warning">Never leave batteries unattended when they are in use or charging.</div>
3028

31-
It would be advisable to take note of these,
32-
especially that one! You will also come across some blue boxes providing information,
33-
similar to the following:
29+
You should take note of these, they often contain important safety information.
3430

35-
<div class="info">Some useful information... like the information given in the information box above.</div>
31+
You will also come across some blue boxes providing key bits of information, similar to the following:
32+
33+
<div class="info">
34+
Taking images while moving will cause them to be blurry, which will cause marker detection to fail.
35+
Try pausing movement while taking an image.
36+
</div>
37+
38+
These contain useful tips that will help you when building your robot.

0 commit comments

Comments
 (0)