Restructure pages and chapters (#61)

* Initial restructure of pages * Updates chapters and slugs * Updates links * Fixes vision chapter location * Changes 'The NUbots Team' to 'Team' * Renames for reorder after added git page * Move flashing a robot and rename nubots to main codebase
NUbots · Jul 25, 2020 · 6d076f6 · 6d076f6
1 parent 0bade91
commit 6d076f6
Show file tree

Hide file tree

Showing 78 changed files with 123 additions and 136 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,8 @@
+{
+    "grammarly.dialect": "british",
+    "grammarly.domain": "technical",
+    "grammarly.userWords": [
+        "NUbots",
+        "NUbook"
+    ]
+}
diff --git a/README.md b/README.md
@@ -221,7 +221,7 @@ Pages are written in MDX files and stored in section and chapter folders in the
 
 ```md
 ---
-section: The NUbots Team
+section: Team
 chapter: Introduction
 title: Introduction to NUbots
 description: Learn about what we do, key people, and where to find the lab.

diff --git a/src/book/01-team/01-introduction/01-introduction-to-nubots.mdx b/src/book/01-team/01-introduction/01-introduction-to-nubots.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: Introduction
 title: Introduction to NUbots
 description: Learn about what we do, key people, and where to find the lab.

diff --git a/src/book/01-team/01-introduction/02-areas-of-research.mdx b/src/book/01-team/01-introduction/02-areas-of-research.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: Introduction
 title: Areas of Research
 description: Find out what you can do at NUbots.

diff --git a/src/book/01-team/01-introduction/03-current-team.mdx b/src/book/01-team/01-introduction/03-current-team.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: Introduction
 title: Current Team
 description: The current members of the NUbots team, and what they do.

diff --git a/src/book/01-team/02-joining/01-how-we-work.mdx b/src/book/01-team/02-joining/01-how-we-work.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: Joining the Team
 title: How We Work
 description: The NUbots collaboration and development process.

diff --git a/src/book/01-team/02-joining/02-how-to-join.mdx b/src/book/01-team/02-joining/02-how-to-join.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: Joining the Team
 title: How to Join NUbots
 description: Find out how you can get involved.

diff --git a/src/book/01-team/02-joining/03-induction.mdx b/src/book/01-team/02-joining/03-induction.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: Joining the Team
 title: Lab Induction
 description: The NUbots lab induction process for new members.

diff --git a/src/book/01-team/03-community/01-sponsors.mdx b/src/book/01-team/03-community/01-sponsors.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: Community
 title: Sponsors
 description: The organisations and companies that fund NUbots research.

diff --git a/src/book/01-team/03-community/02-connect.mdx b/src/book/01-team/03-community/02-connect.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: Community
 title: Connect
 description: How to contact us or join the NUbots community.

diff --git a/src/book/01-team/04-history/01-team-history.mdx b/src/book/01-team/04-history/01-team-history.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: History
 title: Team History
 description: Written history of the NUbots team.

diff --git a/src/book/01-team/04-history/02-past-members.mdx b/src/book/01-team/04-history/02-past-members.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: History
 title: Past Members
 description: Alumni and past members of the NUbots team.

diff --git a/src/book/01-team/04-history/03-publications.mdx b/src/book/01-team/04-history/03-publications.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: History
 title: Publications
 description: Discover all of the NUbots publications.

diff --git a/src/book/01-team/05-robocup/01-robocup.mdx b/src/book/01-team/05-robocup/01-robocup.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: RoboCup
 title: RoboCup
 description: Introduction to the RoboCup competition.

diff --git a/src/book/01-team/05-robocup/02-resources.mdx b/src/book/01-team/05-robocup/02-resources.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: RoboCup
 title: Resources
 description: Resources for the RoboCup competition.

diff --git a/src/book/01-team/05-robocup/03-debriefs.mdx b/src/book/01-team/05-robocup/03-debriefs.mdx
@@ -1,5 +1,5 @@
 ---
-section: The NUbots Team
+section: Team
 chapter: RoboCup
 title: Debriefs
 description: Debriefs and takeaways from our performances at RoboCup.

diff --git a/src/book/02-system/01-nubots/01-overview.mdx → .../02-system/01-foundations/01-overview.mdx b/src/book/02-system/01-nubots/01-overview.mdx → .../02-system/01-foundations/01-overview.mdx
@@ -1,9 +1,9 @@
 ---
 section: System
-chapter: NUbots
+chapter: Foundations
 title: Overview
 description: Introduction to the NUbots codebase and high-level architecture.
-slug: /system/nubots/overview
+slug: /system/foundations/overview
 ---
 
 The NUbots repository is the main codebase that runs on the robots. Its purpose is to control the robot during RoboCup matches. The NUbots codebase, along with all other NUbots code, is open source and can be [found on GitHub](https://github.com/NUbots/NUbots/). The primary language in the NUbots codebase is C++.

diff --git a/...k/02-system/01-nubots/02-build-system.mdx → ...system/01-foundations/02-build-system.mdx b/...k/02-system/01-nubots/02-build-system.mdx → ...system/01-foundations/02-build-system.mdx
@@ -1,9 +1,9 @@
 ---
 section: System
-chapter: NUbots
+chapter: Foundations
 title: Build System
 description: The NUbots build system.
-slug: /system/nubots/build-system
+slug: /system/foundations/build-system
 ---
 
 ## The NUbots Build System

diff --git a/...m/01-nubots/03-continuous-integration.mdx → ...foundations/03-continuous-integration.mdx b/...m/01-nubots/03-continuous-integration.mdx → ...foundations/03-continuous-integration.mdx
@@ -1,9 +1,9 @@
 ---
 section: System
-chapter: NUbots
+chapter: Foundations
 title: Continuous Integration
 description: The NUbots continuous integration system.
-slug: /system/nubots/ci-system
+slug: /system/foundations/ci-system
 ---
 
 ## Overview

diff --git a/src/book/02-system/01-nubots/04-nuclear.mdx → ...k/02-system/01-foundations/04-nuclear.mdx b/src/book/02-system/01-nubots/04-nuclear.mdx → ...k/02-system/01-foundations/04-nuclear.mdx
@@ -1,14 +1,14 @@
 ---
 section: System
-chapter: NUbots
+chapter: Foundations
 title: NUClear
 description: Introduction to NUClear and how it is used in the NUbots codebase.
-slug: /system/nubots/nuclear
+slug: /system/foundations/nuclear
 ---
 
 NUClear is the software framework used in the main NUbots codebase. It is a message passing system designed to be modular and fast.
 
-This page is intended to be a practical summary of the official [NUClear documentation](https://nuclear.readthedocs.io/en/latest/), which contains a detailed description of NUClear. The [NUClear Roles repository](https://github.com/Fastcode/NUClearRoles) contains a detailed description of the NUClear roles system, much of which the [roles section](/system/nubots/nuclear/#nuclear-roles) in this page is based off.
+This page is intended to be a practical summary of the official [NUClear documentation](https://nuclear.readthedocs.io/en/latest/), which contains a detailed description of NUClear. The [NUClear Roles repository](https://github.com/Fastcode/NUClearRoles) contains a detailed description of the NUClear roles system, much of which the [roles section](#nuclear-roles) in this page is based off.
 
 # Components
 
@@ -26,7 +26,7 @@ A reactor can be thought of as a module. All modules in the NUClear system are a
 
 Reactions run tasks when the required data is available and/or when certain conditions are true. A task is the current execution of a defined reaction within the system. These functions are bound by NUClear as callbacks, and it is the execution of these callbacks which will assign tasks to a thread.
 
-Reactions are created by subscribing to the PowerPlant through [DSL On Statements](/system/nubots/nuclear/#on-statements).
+Reactions are created by subscribing to the PowerPlant through [DSL On Statements](#on-statements).
 
 # NUClear DSL
 

diff --git a/...ok/02-system/01-nubots/11-mathematics.mdx → ...-system/01-foundations/05-mathematics.mdx b/...ok/02-system/01-nubots/11-mathematics.mdx → ...-system/01-foundations/05-mathematics.mdx
@@ -1,9 +1,9 @@
 ---
 section: System
-chapter: NUbots
+chapter: Foundations
 title: Mathematics
 description: Detailed explanation of how mathematics is written in the NUbots codebase.
-slug: /system/nubots/mathematics
+slug: /system/foundations/mathematics
 ---
 
 The NUbots codebase uses specific mathematical concepts and notation that are relevant to the field of robotics. In the codebase there are many uses of vectors, matrices, spaces, and transforms between spaces. Specific notation is used for these transforms for better readability. This page details how these concepts and notations are implemented in the codebase.

diff --git a/.../02-system/01-nubots/09-config-script.mdx → ...ystem/01-foundations/09-config-script.mdx b/.../02-system/01-nubots/09-config-script.mdx → ...ystem/01-foundations/09-config-script.mdx
@@ -1,9 +1,9 @@
 ---
 section: System
-chapter: NUbots
+chapter: Foundations
 title: Configuration and Script System
 description: The configuration and script system
-slug: /system/nubots/config-script
+slug: /system/foundations/config-script
 ---
 
 ## The Configuration System

diff --git a/...ok/02-system/01-nubots/assets/ci_setup.sh → ...-system/01-foundations/assets/ci_setup.sh b/...ok/02-system/01-nubots/assets/ci_setup.sh → ...-system/01-foundations/assets/ci_setup.sh
diff --git a/...system/01-nubots/images/ci-build-logs.png → ...m/01-foundations/images/ci-build-logs.png b/...system/01-nubots/images/ci-build-logs.png → ...m/01-foundations/images/ci-build-logs.png
diff --git a/...m/01-nubots/images/ci-overview-master.svg → ...foundations/images/ci-overview-master.svg b/...m/01-nubots/images/ci-overview-master.svg → ...foundations/images/ci-overview-master.svg
diff --git a/...ystem/01-nubots/images/ci-overview-pr.svg → .../01-foundations/images/ci-overview-pr.svg b/...ystem/01-nubots/images/ci-overview-pr.svg → .../01-foundations/images/ci-overview-pr.svg
diff --git a/...em/01-nubots/images/maths-translation.svg → ...-foundations/images/maths-translation.svg b/...em/01-nubots/images/maths-translation.svg → ...-foundations/images/maths-translation.svg
diff --git a/...2-system/01-nubots/images/power_plant.svg → ...tem/01-foundations/images/power_plant.svg b/...2-system/01-nubots/images/power_plant.svg → ...tem/01-foundations/images/power_plant.svg
diff --git a/...stem/01-nubots/images/right-hand-rule.svg → ...01-foundations/images/right-hand-rule.svg b/...stem/01-nubots/images/right-hand-rule.svg → ...01-foundations/images/right-hand-rule.svg
diff --git a/...em/01-nubots/images/software-overview.svg → ...-foundations/images/software-overview.svg b/...em/01-nubots/images/software-overview.svg → ...-foundations/images/software-overview.svg
diff --git a/src/book/02-system/01-nubots/05-vision.mdx b/src/book/02-system/01-nubots/05-vision.mdx
diff --git a/src/book/02-system/01-nubots/06-localisation.mdx b/src/book/02-system/01-nubots/06-localisation.mdx
diff --git a/src/book/02-system/01-nubots/07-odometry.mdx b/src/book/02-system/01-nubots/07-odometry.mdx
diff --git a/src/book/02-system/01-nubots/08-kinematics.mdx b/src/book/02-system/01-nubots/08-kinematics.mdx
diff --git a/src/book/02-system/01-nubots/09-script-engine.mdx b/src/book/02-system/01-nubots/09-script-engine.mdx
diff --git a/src/book/02-system/01-nubots/10-behavior.mdx b/src/book/02-system/01-nubots/10-behavior.mdx
diff --git a/src/book/02-system/02-nusight/01-overview.mdx b/src/book/02-system/02-nusight/01-overview.mdx
diff --git a/src/book/02-system/02-nusight/02-available-tools.mdx b/src/book/02-system/02-nusight/02-available-tools.mdx
diff --git a/src/book/02-system/02-subsystems/01-odometry.mdx b/src/book/02-system/02-subsystems/01-odometry.mdx
@@ -0,0 +1,7 @@
+---
+section: System
+chapter: Subsystems
+title: Odometry
+description: Odometry and how it works in the NUbots codebase.
+slug: /system/subsystems/odometry
+---
diff --git a/src/book/02-system/02-subsystems/02-localisation.mdx b/src/book/02-system/02-subsystems/02-localisation.mdx
@@ -0,0 +1,7 @@
+---
+section: System
+chapter: Subsystems
+title: Localisation
+description: Localisation and how it works in the NUbots codebase.
+slug: /system/subsystems/localisation
+---
diff --git a/src/book/02-system/02-subsystems/03-vision.mdx b/src/book/02-system/02-subsystems/03-vision.mdx
@@ -0,0 +1,7 @@
+---
+section: System
+chapter: Subsystems
+title: Vision
+description: Vision and how it works in the NUbots codebase.
+slug: /system/subsystems/vision
+---
diff --git a/src/book/02-system/02-subsystems/04-motion.mdx b/src/book/02-system/02-subsystems/04-motion.mdx
@@ -0,0 +1,7 @@
+---
+section: System
+chapter: Subsystems
+title: Motion
+description: Motion and how it works in the NUbots codebase.
+slug: /system/subsystems/motion
+---
diff --git a/src/book/02-system/02-subsystems/05-behavior.mdx b/src/book/02-system/02-subsystems/05-behavior.mdx
@@ -0,0 +1,7 @@
+---
+section: System
+chapter: Subsystems
+title: Behaviour
+description: Behaviour and how it works in the NUbots codebase.
+slug: /system/subsystems/behaviour
+---
diff --git a/src/book/02-system/03-tools/01-nusight.mdx b/src/book/02-system/03-tools/01-nusight.mdx
@@ -0,0 +1,7 @@
+---
+section: System
+chapter: Tools
+title: NUsight
+description: NUsight and how to setup your environment to run it.
+slug: /system/tools/overview
+---
diff --git a/src/book/02-system/04-other/01-nubook.mdx → src/book/02-system/03-tools/02-nubook.mdx b/src/book/02-system/04-other/01-nubook.mdx → src/book/02-system/03-tools/02-nubook.mdx
@@ -1,7 +1,7 @@
 ---
 section: System
-chapter: Other Projects
+chapter: Tools
 title: NUbook
 description: The NUbots team handbook and documentation.
-slug: /system/nubook
+slug: /system/tools/nubook
 ---
diff --git a/src/book/02-system/04-other/02-nupbr.mdx → src/book/02-system/03-tools/03-nupbr.mdx b/src/book/02-system/04-other/02-nupbr.mdx → src/book/02-system/03-tools/03-nupbr.mdx
@@ -1,9 +1,9 @@
 ---
 section: System
-chapter: Other Projects
+chapter: Tools
 title: NUpbr
 description: A physically-based rendering pipeline for generating realistic semi-synthetic data.
-slug: /system/nupbr
+slug: /system/tools/nupbr
 keywords:
   [
     vision,

diff --git a/...book/02-system/04-other/images/ball_L.png → ...book/02-system/03-tools/images/ball_L.png b/...book/02-system/04-other/images/ball_L.png → ...book/02-system/03-tools/images/ball_L.png
diff --git a/...-system/04-other/images/robot_outside.png → ...-system/03-tools/images/robot_outside.png b/...-system/04-other/images/robot_outside.png → ...-system/03-tools/images/robot_outside.png
diff --git a/...ook/02-system/03-hardware/01-overview.mdx → ...ook/02-system/04-hardware/01-overview.mdx b/...ook/02-system/03-hardware/01-overview.mdx → ...ook/02-system/04-hardware/01-overview.mdx
diff --git a/...ok/02-system/03-hardware/images/nugus.png → ...ok/02-system/04-hardware/images/nugus.png b/...ok/02-system/03-hardware/images/nugus.png → ...ok/02-system/04-hardware/images/nugus.png
diff --git a/...m/03-hardware/images/servo-tranzorb-1.png → ...m/04-hardware/images/servo-tranzorb-1.png b/...m/03-hardware/images/servo-tranzorb-1.png → ...m/04-hardware/images/servo-tranzorb-1.png
diff --git a/...m/03-hardware/images/servo-tranzorb-2.png → ...m/04-hardware/images/servo-tranzorb-2.png b/...m/03-hardware/images/servo-tranzorb-2.png → ...m/04-hardware/images/servo-tranzorb-2.png
diff --git a/...3-guides/01-nubots/01-getting-started.mdx → ...s/01-main-codebase/01-getting-started.mdx b/...3-guides/01-nubots/01-getting-started.mdx → ...s/01-main-codebase/01-getting-started.mdx
@@ -1,9 +1,9 @@
 ---
 section: Guides
-chapter: NUbots
+chapter: Main Codebase
 title: Getting Started
 description: Setting up your environment and getting started with NUbots development.
-slug: /guides/nubots/getting-started
+slug: /guides/main/getting-started
 ---
 
 ## Prerequisites

diff --git a/...s/01-nubots/images/docker-running-mac.png → ...in-codebase/images/docker-running-mac.png b/...s/01-nubots/images/docker-running-mac.png → ...in-codebase/images/docker-running-mac.png
diff --git a/...ages/flashing/bios_boot_configuration.jpg → ...ages/flashing/bios_boot_configuration.jpg b/...ages/flashing/bios_boot_configuration.jpg → ...ages/flashing/bios_boot_configuration.jpg
diff --git a/.../01-nubots/images/flashing/bios_power.jpg → ...n-codebase/images/flashing/bios_power.jpg b/.../01-nubots/images/flashing/bios_power.jpg → ...n-codebase/images/flashing/bios_power.jpg
diff --git a/...bots/images/flashing/bios_secure_boot.jpg → ...base/images/flashing/bios_secure_boot.jpg b/...bots/images/flashing/bios_secure_boot.jpg → ...base/images/flashing/bios_secure_boot.jpg
diff --git a/...es/01-nubots/images/flashing/internet.jpg → ...ain-codebase/images/flashing/internet.jpg b/...es/01-nubots/images/flashing/internet.jpg → ...ain-codebase/images/flashing/internet.jpg
diff --git a/...bots/images/flashing/known_interfaces.jpg → ...base/images/flashing/known_interfaces.jpg b/...bots/images/flashing/known_interfaces.jpg → ...base/images/flashing/known_interfaces.jpg
diff --git a/...des/01-nubots/images/flashing/liveusb.jpg → ...main-codebase/images/flashing/liveusb.jpg b/...des/01-nubots/images/flashing/liveusb.jpg → ...main-codebase/images/flashing/liveusb.jpg
diff --git a/...uides/01-nubots/images/flashing/login.jpg → ...1-main-codebase/images/flashing/login.jpg b/...uides/01-nubots/images/flashing/login.jpg → ...1-main-codebase/images/flashing/login.jpg
diff --git a/...01-nubots/images/flashing/no_internet.jpg → ...-codebase/images/flashing/no_internet.jpg b/...01-nubots/images/flashing/no_internet.jpg → ...-codebase/images/flashing/no_internet.jpg
diff --git a/src/book/03-guides/01-nubots/03-troubleshooting.mdx b/src/book/03-guides/01-nubots/03-troubleshooting.mdx
diff --git a/src/book/03-guides/02-nusight/02-troubleshooting.mdx b/src/book/03-guides/02-nusight/02-troubleshooting.mdx
diff --git a/...ides/02-nusight/01-contribution-guide.mdx → ...guides/02-tools/01-contribution-guide.mdx b/...ides/02-nusight/01-contribution-guide.mdx → ...guides/02-tools/01-contribution-guide.mdx
@@ -1,7 +1,7 @@
 ---
 section: Guides
-chapter: NUsight
-title: Contribution Guide
+chapter: Tools
+title: Contributing to NUsight
 description: All you need to know to start contributing to NUsight.
-slug: /guides/nusight/contribution-guide
+slug: /guides/tools/nusight-contribution
 ---
diff --git a/src/book/03-guides/01-nubots/02-flashing.mdx → ...ook/03-guides/03-hardware/02-flashing.mdx b/src/book/03-guides/01-nubots/02-flashing.mdx → ...ook/03-guides/03-hardware/02-flashing.mdx
@@ -1,9 +1,9 @@
 ---
 section: Guides
-chapter: NUbots
+chapter: Hardware
 title: Flashing a Robot
 description: How to install a new operating system on a robot
-slug: /guides/nubots/flashing
+slug: /guides/hardware/flashing
 ---
 
 ## Flashing a Robot