Skip to content

Commit e15503b

Browse files
authored
Merge pull request #520 from srobo/jdp-multipage-tweaks
2 parents f8dad10 + c0a40ab commit e15503b

File tree

15 files changed

+57
-46
lines changed

15 files changed

+57
-46
lines changed

_data/sidebar_tree.yaml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ tree:
2020
title: Student Robotics OS
2121
- url: /kit/brain_board/python_libraries
2222
title: Python Libraries
23-
- url: /kit/brain_board/wifi
24-
title: WiFi
23+
- url: /kit/brain_board/web_interface
24+
title: Web Interface
2525
- url: /kit/brain_board/advanced
2626
title: Advanced
2727
- url: /kit/motor_board
@@ -68,15 +68,13 @@ tree:
6868
title: Custom Firmware
6969
- url: /programming/cheat_sheet
7070
title: API Quick Reference
71-
- url: /programming/simulator_programming
72-
title: Simulator Programming
7371
- url: /rules/
7472
title: Rules
7573
tree:
76-
- url: /rules/code_of_conduct
77-
title: Code Of Conduct
78-
- url: /rules/safety_regulations
79-
title: Safety Regulations
74+
#- url: /rules/code_of_conduct
75+
# title: Code Of Conduct
76+
#- url: /rules/safety_regulations
77+
# title: Safety Regulations
8078
- url: /rules/archive
8179
title: Game Rules Archive
8280
- url: /tutorials/
@@ -97,12 +95,19 @@ tree:
9795
title: PyCharm
9896
- url: /tutorials/editors/vscode
9997
title: Visual Studio Code
100-
- url: /tutorials/setting_up_simulator
101-
title: Setting up the simulator
102-
- url: /tutorials/using_the_simulator
103-
title: Using the simulator
10498
- url: /tutorials/update_brain
10599
title: Updating your brain board
100+
- url: /tutorials/discord
101+
title: How to use Discord
102+
- url: /simulator/
103+
title: Simulator
104+
tree:
105+
- url: /simulator/simulator_programming
106+
title: Simulator Programming
107+
- url: /simulator/setting_up_simulator
108+
title: Setting up the simulator
109+
- url: /simulator/using_the_simulator
110+
title: Using the simulator
106111
- url: /troubleshooting/
107112
title: Troubleshooting
108113
tree:
@@ -117,8 +122,3 @@ tree:
117122
title: Microgames
118123
- url: /competitor_resources/markers
119124
title: Game markers
120-
- url: /team_admin/
121-
title: Team Admin
122-
tree:
123-
- url: /team_admin/discord
124-
title: Discord Server

competitor_resources/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ layout: page
33
title: Resources
44
---
55

6-
Resources
7-
=========
6+
# Resources
87

9-
TODO
8+
The below pages contain downloadable resources that will be needed during development.

competitor_resources/markers.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,10 @@ title: Game markers
55

66
# Game markers
77

8+
The game markers are the AprilTags that are located in defined locations around the arena.
9+
For information about what these are check the [vision marker page]({{ site.baseurl}}/programming/vision/markers).
10+
For guidance of where these will be located in the arena, look at this years [rules]({{ site.baseurl}}/rules).
11+
12+
## Download
13+
14+
The markers for the SR2024 competition will be released at Kickstart.

competitor_resources/microgames.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,14 @@ layout: page
33
title: Microgames
44
---
55

6-
Microgames
7-
==========
6+
# Microgames
87

9-
The microgames are way of getting familiar with your kit through a series of challenges.
8+
The microgames are way of getting familiar with your kit through a series of small challenges.
109

11-
Here is a link to the [Microgames](https://studentrobotics.org/microgames).
1210

13-
We recommend you work through them as a team, so you can learn from each other. If you have any issues, just ask us on [Discord](/docs/team_admin/discord).
11+
We recommend you work through them as a team, so you can learn from each other. If you have any issues, just ask us on [Discord](/docs/tutorials/discord).
12+
13+
14+
## Download
15+
16+
The Microgames for the SR2024 competition will be released at Kickstart.

kit/brain_board/advanced.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ title: Brain Board - Advanced
66

77
# Brain Board - Advanced
88

9-
When connected to your [Brain Board WiFi]({{ site.baseurl }}/kit/brain_board/wifi), it is possible to access the Brain Board via a terminal interface.
10-
The Brain Board is running Student Robotics OS, a purpose-built Linux distribution.
9+
When connected to your [Brain Board's WiFi]({{ site.baseurl }}/kit/brain_board/web_interface), it is possible to access the Brain Board via a terminal interface.
10+
The Brain Board is running the [Student Robotics OS]({{ site.baseurl}}/kit/brain_board/robot_os).
1111

1212
<div class="warning">
1313
Proceed at your own risk. We only provide limited support for these advanced features.
@@ -19,7 +19,7 @@ Please bear in mind the following:
1919
- We may need you to upgrade the OS which will overwrite any changes.
2020
- Any modifications you make must be in line with [the rules]({{ site.baseurl }}/rules).
2121
- We reserve the right to inspect your Brain Board at any time.
22-
- Feel free to tinker. If you are stuck, ask in [Discord]({{ site.baseurl }}/team_admin/discord), we may be able to help.
22+
- Feel free to tinker. If you are stuck, ask in [Discord]({{ site.baseurl }}/tutorials/discord), we may be able to help.
2323

2424

2525
## SSH Access

kit/brain_board/python_libraries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If you wish to use a library that isn't in the list, get in contact with us on D
1313

1414
<div class="info" markdown="1">
1515
Note that for local development in the simulator you will need to install the libraries yourself.
16-
Look at the guide on [setting up the simulator]({{ site.baseurl }}/tutorials/setting_up_simulator) to find out how to do this.
16+
Look at the guide on [setting up the simulator]({{ site.baseurl }}/simulator/setting_up_simulator) to find out how to do this.
1717
</div>
1818

1919

kit/brain_board/wifi.md renamed to kit/brain_board/web_interface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
22
layout: page
3-
title: WiFi
3+
title: Web Interface
44
---
55

66

7-
# WiFi
7+
# Web Interface
88

99
The Raspberry Pi that makes up your kit's brain board has WiFi which allows you to connect to and debug your robot, using any WiFi capable device (laptop, tablet, phone, etc.).
1010
The WiFi is only available during development and will be disabled during competition matches.

simulator/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: page
3+
title: Simulator
4+
---
5+
6+
# Simulator
7+
8+
The simulator is used for the virtual competition but can also be a useful tool for becoming more familiar with our API or planning out game strategies.
9+
10+
The below pages contain guidance on how to use the simulator.
11+
Guiding you through installation, writing code and then running matches.
12+

tutorials/setting_up_simulator.md renamed to simulator/setting_up_simulator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,6 @@ If you need a specific version of the simulator, or want to see what changes
8383
have been made with each version, please see the
8484
[list of releases](https://github.com/srobo/competition-simulator/releases).
8585
86-
[discord]: {{ site.baseurl }}/team_admin/discord
86+
[discord]: {{ site.baseurl }}/tutorials/discord
8787
[programming-help]: https://discord.com/channels/900501415548579842/900501416269971457
8888
[simulator-help]: https://discord.com/channels/900501415548579842/900501416269971458
File renamed without changes.

0 commit comments

Comments
 (0)