Minimum viable SR2024 docs

Author: 8BitJosh

.spelling

@@ -16,6 +16,8 @@ Plazma
 PULLUP
 Quarternion
 rtui
+Arduino
+Arduinos
 Ruggeduino
 Ruggeduinos
 Scarzy

.vscode/extensions.json

@@ -48,7 +48,7 @@ task :validate_kit_versions do
   data = YAML.load_file('_data/kit_versions.yml')
   data.each do |entry|
     actual = entry.keys.to_set
-    expected = ['version', 'released', 'changelog'].to_set
+    expected = ['version', 'released', 'link', 'changelog'].to_set
     optional = ['yanked'].to_set
     missing = expected - actual - optional
     extra = actual - expected - optional

Rakefile

@@ -2,32 +2,12 @@
 # The format of this file should be like such:
 # - version: 20xx.y.z
 #   released: 2038-01-19
+#   link: https://link-to-download.img
 #   changelog:
 #     - Changed something
 #     - Changed another thing too
-- version: 2023.2.1
-  released: 2023-01-07
+- version: 2024.1.0
+  released: 2023-09-14
+  link: https://github.com/srobo/robot-image/releases/download/2024.1.0/Student.Robotics.OS-image-2024.1.0.img.xz
   changelog:
-    - Fixed issue in camera optimisation that caused JPEG corruption.
-- version: 2023.2.0
-  released: 2023-01-05
-  yanked: true
-  changelog:
-    - Reworked underlying vision library to improve marker detection and distance calculation.
-    - Added a display of last captured image in web UI.
-- version: 2023.1.0
-  released: 2022-12-01
-  changelog:
-    - Added dark theme and WiFi details to web interface.
-    - Added terminal interface.
-    - Updated axes for orientations.
-    - Added frame argument to camera operations.
-    - Added robot settings error file.
-    - Added competitor port range (7000-8999) to firewall.
-    - Updated C270 and B500 camera calibrations.
-    - Fixed bug where stopping running code didn't work.
-    - Python packages can now be installed onto the brain board using pip.
-- version: 2023.0.0
-  released: 2022-10-21
-  changelog:
-    - Initial release for SR2023.
+    - Initial release for SR2024.

_data/kit_versions.yml

@@ -4,10 +4,8 @@ tree:
   - url: /
     title: Introduction
   - url: /kit/
-    title: Kits
+    title: Kit
     tree:
-    - url: /kit/assembly
-      title: Assembly
     - url: /kit/batteries/
       title: Batteries
       tree:
@@ -18,92 +16,109 @@ tree:
     - url: /kit/brain_board/
       title: Brain Board
       tree:
-        - url: /kit/brain_board/updates
-          title: Updates
+        - url: /kit/brain_board/robot_os
+          title: Student Robotics OS
+        - url: /kit/brain_board/python_libraries
+          title: Python Libraries
+        - url: /kit/brain_board/web_interface
+          title: Web Interface
         - url: /kit/brain_board/advanced
           title: Advanced
     - url: /kit/motor_board
       title: Motor Board
     - url: /kit/power_board
       title: Power Board
-    - url: /kit/ruggeduino
-      title: Ruggeduino
     - url: /kit/servo_board
       title: Servo Board
-    - url: /kit/safety-regulations
-      title: Safety Regulations
-    - url: /kit/wifi
-      title: WiFi
+    - url: /kit/arduino
+      title: Arduino
   - url: /programming/
     title: Programming
     tree:
-    - url: /programming/getting_code_on_the_robot
-      title: Getting Code on the Robot
-    - url: /programming/python/
-      title: Python
+    - url: /programming/robot_api/
+      title: Robot API
       tree:
-      - url: /programming/python/functions
-        title: Functions
-      - url: /programming/python/libraries
-        title: Libraries
-    - url: /programming/sr/
-      title: sr
+      - url: /programming/robot_api/comp_mode
+        title: Competition Mode
+    - url: /programming/leds
+      title: Brain Board LED API
+    - url: /programming/motors
+      title: Motor Board API
+    - url: /programming/power
+      title: Power Board API
+    - url: /programming/servos
+      title: Servo Board API
+    - url: /programming/vision/
+      title: Vision
       tree:
-      - url: /programming/sr/cheat_sheet
-        title: API Quick Reference
-      - url: /programming/sr/leds/
-        title: LEDs
-      - url: /programming/sr/motors/
-        title: Motors
-      - url: /programming/sr/power/
-        title: Power
-      - url: /programming/sr/ruggeduinos/
-        title: Ruggeduinos
-        tree:
-        - url: /programming/sr/ruggeduinos/custom_firmware
-          title: Custom Firmware
-      - url: /programming/sr/servos/
-        title: Servos
-      - url: /programming/sr/vision/
-        title: Vision
-        tree:
-        - url: /programming/sr/vision/markers
-          title: Markers
-    - url: /programming/editors/
-      title: Code Editors
+      - url: /programming/vision/markers
+        title: Markers
+      - url: /programming/vision/position
+        title: Position
+      - url: /programming/vision/orientation
+        title: Orientation
+    - url: /programming/arduino/
+      title: Arduino API
       tree:
-      - url: /programming/editors/pycharm
-        title: PyCharm
-      - url: /programming/editors/vscode
-        title: Visual Studio Code
+      - url: /programming/arduino/sr_firmware
+        title: SR Firmware
+      - url: /programming/arduino/extended_sr_firmware
+        title: Extended SR Firmware
+      - url: /programming/arduino/custom_firmware
+        title: Custom Firmware
+    - url: /programming/cheat_sheet
+      title: API Quick Reference
   - url: /rules/
     title: Rules
     tree:
+    #- 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/
+    title: Tutorials
+    tree:
+    - url: /tutorials/assembly
+      title: Kit Assembly
+    - url: /tutorials/python
+      title: An intro to Python
+    - url: /tutorials/getting_code_on_the_robot
+      title: Getting Code on the Robot
+    - url: /tutorials/basic_motor_control
+      title: Basic Motor Control
+    - url: /tutorials/editors/
+      title: Code Editors
+      tree:
+      - url: /tutorials/editors/pycharm
+        title: PyCharm
+      - url: /tutorials/editors/vscode
+        title: Visual Studio Code
+    - url: /tutorials/update_brain
+      title: Updating your brain board
+    - url: /tutorials/discord
+      title: How to use Discord
   - url: /simulator/
     title: Simulator
     tree:
-      - url: /simulator/programming/
-        title: Programming
+    - 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:
     - url: /troubleshooting/python
       title: Python
     - url: /troubleshooting/interactive_troubleshooter
       title: Interactive Troubleshooter
-  - url: /tutorials/
-    title: Tutorials
+  - url: /competitor_resources/
+    title: Resources
     tree:
-    - url: /tutorials/basic_motor_control
-      title: Basic Motor Control
-    - url: /tutorials/microgames
+    - url: /competitor_resources/microgames
       title: Microgames
-    - url: /tutorials/python
-      title: Python
-  - url: /team_admin/
-    title: Team Admin
-    tree:
-    - url: /team_admin/discord
-      title: Discord Server
+    - url: /competitor_resources/markers
+      title: Game markers

_data/sidebar_tree.yaml

@@ -8,7 +8,7 @@ <h2><code>{{ version }} ({{ kit_version.released | date_to_string }})</code></h2
   {% if kit_version.yanked %}
   <p>This version is no longer available.</p>
   {% else %}
-  <a class="kit-download-link" data-version="{{ version }}" href="https://github.com/srobo/robot-image/releases/download/v{{ version }}/srobo-image-robot-{{ version }}.img.xz">
+  <a class="kit-download-link" data-version="{{ version }}" href="{{ kit_version.link }}">
       Download {{ version }}
   </a>
   {% endif %}

_includes/updates-list.html

@@ -0,0 +1,8 @@
+---
+layout: page
+title: Resources
+---
+
+# Resources
+
+The below pages contain downloadable resources that will be needed during development.

competitor_resources/index.md

@@ -0,0 +1,14 @@
+---
+layout: page
+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.

competitor_resources/markers.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.