You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: index.md
+18-15Lines changed: 18 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,30 +6,33 @@ title: Documentation
6
6
Introduction
7
7
============
8
8
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:
16
11
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.
17
16
18
17
Within this documentation, you will come across a number of boxes like this:
19
18
20
19
~~~~~python
21
20
# code example
22
21
~~~~~
23
22
24
-
These are code examples provided to help you.
23
+
These are pieces of example code that you can run on your robot.
25
24
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:
28
26
29
-
<divclass="warning">Charge Your Batteries!</div>
27
+
<divclass="warning">Never leave batteries unattended when they are in use or charging.</div>
30
28
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.
34
30
35
-
<divclass="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
+
<divclass="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