diff --git a/_data/sidebar_tree.yaml b/_data/sidebar_tree.yaml index f66f4f78..a41f92f2 100644 --- a/_data/sidebar_tree.yaml +++ b/_data/sidebar_tree.yaml @@ -20,8 +20,8 @@ tree: title: Student Robotics OS - url: /kit/brain_board/python_libraries title: Python Libraries - - url: /kit/brain_board/wifi - title: WiFi + - url: /kit/brain_board/web_interface + title: Web Interface - url: /kit/brain_board/advanced title: Advanced - url: /kit/motor_board @@ -68,15 +68,13 @@ tree: title: Custom Firmware - url: /programming/cheat_sheet title: API Quick Reference - - url: /programming/simulator_programming - title: Simulator Programming - url: /rules/ title: Rules tree: - - url: /rules/code_of_conduct - title: Code Of Conduct - - url: /rules/safety_regulations - title: Safety Regulations + #- url: /rules/code_of_conduct + # title: Code Of Conduct + #- url: /rules/safety_regulations + # title: Safety Regulations - url: /rules/archive title: Game Rules Archive - url: /tutorials/ @@ -97,12 +95,19 @@ tree: title: PyCharm - url: /tutorials/editors/vscode title: Visual Studio Code - - url: /tutorials/setting_up_simulator - title: Setting up the simulator - - url: /tutorials/using_the_simulator - title: Using the simulator - url: /tutorials/update_brain title: Updating your brain board + - url: /tutorials/discord + title: How to use Discord + - url: /simulator/ + title: Simulator + tree: + - url: /simulator/simulator_programming + title: Simulator Programming + - url: /simulator/setting_up_simulator + title: Setting up the simulator + - url: /simulator/using_the_simulator + title: Using the simulator - url: /troubleshooting/ title: Troubleshooting tree: @@ -117,8 +122,3 @@ tree: title: Microgames - url: /competitor_resources/markers title: Game markers - - url: /team_admin/ - title: Team Admin - tree: - - url: /team_admin/discord - title: Discord Server diff --git a/competitor_resources/index.md b/competitor_resources/index.md index af0b344b..1882ea0d 100644 --- a/competitor_resources/index.md +++ b/competitor_resources/index.md @@ -3,7 +3,6 @@ layout: page title: Resources --- -Resources -========= +# Resources -TODO \ No newline at end of file +The below pages contain downloadable resources that will be needed during development. diff --git a/competitor_resources/markers.md b/competitor_resources/markers.md index b0609cc7..f22a861b 100644 --- a/competitor_resources/markers.md +++ b/competitor_resources/markers.md @@ -5,3 +5,10 @@ title: Game markers # Game markers +The game markers are the AprilTags that are located in defined locations around the arena. +For information about what these are check the [vision marker page]({{ site.baseurl}}/programming/vision/markers). +For guidance of where these will be located in the arena, look at this years [rules]({{ site.baseurl}}/rules). + +## Download + +The markers for the SR2024 competition will be released at Kickstart. diff --git a/competitor_resources/microgames.md b/competitor_resources/microgames.md index a7992175..484665c2 100644 --- a/competitor_resources/microgames.md +++ b/competitor_resources/microgames.md @@ -3,11 +3,14 @@ layout: page title: Microgames --- -Microgames -========== +# Microgames -The microgames are way of getting familiar with your kit through a series of challenges. +The microgames are way of getting familiar with your kit through a series of small challenges. -Here is a link to the [Microgames](https://studentrobotics.org/microgames). -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). +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). + + +## Download + +The Microgames for the SR2024 competition will be released at Kickstart. diff --git a/kit/brain_board/advanced.md b/kit/brain_board/advanced.md index 4fa37c33..1fc2e761 100644 --- a/kit/brain_board/advanced.md +++ b/kit/brain_board/advanced.md @@ -6,8 +6,8 @@ title: Brain Board - Advanced # Brain Board - Advanced -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. -The Brain Board is running Student Robotics OS, a purpose-built Linux distribution. +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. +The Brain Board is running the [Student Robotics OS]({{ site.baseurl}}/kit/brain_board/robot_os).
Proceed at your own risk. We only provide limited support for these advanced features. @@ -19,7 +19,7 @@ Please bear in mind the following: - We may need you to upgrade the OS which will overwrite any changes. - Any modifications you make must be in line with [the rules]({{ site.baseurl }}/rules). - We reserve the right to inspect your Brain Board at any time. -- Feel free to tinker. If you are stuck, ask in [Discord]({{ site.baseurl }}/team_admin/discord), we may be able to help. +- Feel free to tinker. If you are stuck, ask in [Discord]({{ site.baseurl }}/tutorials/discord), we may be able to help. ## SSH Access diff --git a/kit/brain_board/python_libraries.md b/kit/brain_board/python_libraries.md index 9d2abce0..eaedcff7 100644 --- a/kit/brain_board/python_libraries.md +++ b/kit/brain_board/python_libraries.md @@ -13,7 +13,7 @@ If you wish to use a library that isn't in the list, get in contact with us on D
Note that for local development in the simulator you will need to install the libraries yourself. -Look at the guide on [setting up the simulator]({{ site.baseurl }}/tutorials/setting_up_simulator) to find out how to do this. +Look at the guide on [setting up the simulator]({{ site.baseurl }}/simulator/setting_up_simulator) to find out how to do this.
diff --git a/kit/brain_board/wifi.md b/kit/brain_board/web_interface.md similarity index 98% rename from kit/brain_board/wifi.md rename to kit/brain_board/web_interface.md index 2c502435..47cd76c9 100644 --- a/kit/brain_board/wifi.md +++ b/kit/brain_board/web_interface.md @@ -1,10 +1,10 @@ --- layout: page -title: WiFi +title: Web Interface --- -# WiFi +# Web Interface 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.). The WiFi is only available during development and will be disabled during competition matches. diff --git a/simulator/index.md b/simulator/index.md new file mode 100644 index 00000000..96ea7f0c --- /dev/null +++ b/simulator/index.md @@ -0,0 +1,12 @@ +--- +layout: page +title: Simulator +--- + +# Simulator + +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. + +The below pages contain guidance on how to use the simulator. +Guiding you through installation, writing code and then running matches. + diff --git a/tutorials/setting_up_simulator.md b/simulator/setting_up_simulator.md similarity index 98% rename from tutorials/setting_up_simulator.md rename to simulator/setting_up_simulator.md index 3e8acc08..a06d21f3 100644 --- a/tutorials/setting_up_simulator.md +++ b/simulator/setting_up_simulator.md @@ -83,6 +83,6 @@ If you need a specific version of the simulator, or want to see what changes have been made with each version, please see the [list of releases](https://github.com/srobo/competition-simulator/releases). -[discord]: {{ site.baseurl }}/team_admin/discord +[discord]: {{ site.baseurl }}/tutorials/discord [programming-help]: https://discord.com/channels/900501415548579842/900501416269971457 [simulator-help]: https://discord.com/channels/900501415548579842/900501416269971458 diff --git a/programming/simulator_programming.md b/simulator/simulator_programming.md similarity index 100% rename from programming/simulator_programming.md rename to simulator/simulator_programming.md diff --git a/tutorials/using_the_simulator.md b/simulator/using_the_simulator.md similarity index 91% rename from tutorials/using_the_simulator.md rename to simulator/using_the_simulator.md index 748c34fb..a92e29bb 100644 --- a/tutorials/using_the_simulator.md +++ b/simulator/using_the_simulator.md @@ -38,8 +38,8 @@ speeds (▶▶ and ▶▶▶). These differences mean that your code will need to use a different mechanism to find the current time or to sleep within the simulation. Find out more by -heading over to the [simulator programming docs](/docs/programming/simulator_programming). +heading over to the [simulator programming docs](/docs/simulator/simulator_programming). ## Programming -Once you have the simulator installed you can begin [programming your robot](/docs/programming/simulator_programming) in the simulator. +Once you have the simulator installed you can begin [programming your robot](/docs/simulator/simulator_programming) in the simulator. diff --git a/team_admin/index.md b/team_admin/index.md deleted file mode 100644 index 9b066258..00000000 --- a/team_admin/index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -layout: page -title: Team Admin ---- - -Team Admin -========== - -See [Discord](/docs/team_admin/discord) for details on the Discord based forums -where your team can get help & support. diff --git a/team_admin/discord.md b/tutorials/discord.md similarity index 100% rename from team_admin/discord.md rename to tutorials/discord.md diff --git a/tutorials/editors/vscode.md b/tutorials/editors/vscode.md index 75a37f38..476fd6a5 100644 --- a/tutorials/editors/vscode.md +++ b/tutorials/editors/vscode.md @@ -42,7 +42,7 @@ you'll need to make the library available within the Python environment that you This documentation refers to a feature which is only available from software version 2023.1.0 and later.
-When connected to the [robot's WiFi hotspot]({{ site.baseurl }}/kit/brain_board/wifi), it is possible to attach VS Code's +When connected to the [robot's WiFi hotspot]({{ site.baseurl }}/kit/brain_board/web_interface), it is possible to attach VS Code's debugger to the robot by performing the following steps: 1. Ensure the [Python extension](#python-extension) is installed. diff --git a/tutorials/getting_code_on_the_robot.md b/tutorials/getting_code_on_the_robot.md index c51323d5..efe75f12 100644 --- a/tutorials/getting_code_on_the_robot.md +++ b/tutorials/getting_code_on_the_robot.md @@ -33,4 +33,4 @@ To re-run your program, simply remove the USB stick from the robot and plug it b ## Robot Logs When your program runs on the robot, the output of `print(...)` statements and any errors which occur are written to a log file on the USB stick as `log.txt`. -These logs are also available to view live on the [web interface]({{ site.baseurl }}/kit/brain_board/wifi). +These logs are also available to view live on the [web interface]({{ site.baseurl }}/kit/brain_board/web_interface).