From 705047596c2a8b125191ebe4b4baa96695a55ed2 Mon Sep 17 00:00:00 2001 From: Andrew Goeden Date: Sun, 4 Aug 2024 23:32:29 -0400 Subject: [PATCH] Updated top level table of contacts --- src/Administrative/administrative.md | 1 + src/Introduction.md | 57 +++++++++++++++++++++++++++- src/Overview.md | 8 ---- 3 files changed, 57 insertions(+), 9 deletions(-) diff --git a/src/Administrative/administrative.md b/src/Administrative/administrative.md index 123e6da..9d37a62 100644 --- a/src/Administrative/administrative.md +++ b/src/Administrative/administrative.md @@ -1,3 +1,4 @@ + # Administrative ## Who is allowed to compete diff --git a/src/Introduction.md b/src/Introduction.md index ab439fe..7a6acc1 100644 --- a/src/Introduction.md +++ b/src/Introduction.md @@ -2,4 +2,59 @@ ## What is the competition -The Autonomous Karting Series is a collegiate competition series in which teams design, build, and race autonomous electric go-karts. \ No newline at end of file +The Autonomous Karting Series is a collegiate competition series in which teams design, build, and race autonomous electric go-karts. + +## [Administrative](src/Administrative/administrative.md) + +- [Who Is Allowed To Compete](src/Administrative/administrative.md#who-is-allowed-to-compete) +- [Required Roles](src/Administrative/administrative.md#required-roles) +- [Documentation Requirements From Teams](src/Administrative/administrative.md#documentation-requirements-from-teams) +- [Jurisdiction Of Rules](src/Administrative/administrative.md#jurisdiction-of-rules) +- [Disclaimer](src/Administrative/administrative.md#disclaimer) + +## [Electrical](src/Electrical/electrical.md) + +- [Drivetrain](src/Electrical/electrical.md#drivetrain) +- [Batteries](src/Electrical/electrical.md#batteries) +- [General Wiring](src/Electrical/electrical.md#general-wiring) +- [Computers and Sensors](src/Electrical/electrical.md#computers-and-sensors) +- [Design Documentation](src/Electrical/electrical.md#design-documentation) + +## [Software](src/Software/software.md) + +## [Mechanical](src/Mechanical/mechanical.md) + +- [Frame / Chassis](src/Mechanical/mechanical.md#frame--chassis) +- [Tires](src/Mechanical/mechanical.md#tires) +- [Brakes](src/Mechanical/mechanical.md#brakes) +- [Weight](src/Mechanical/mechanical.md#weight) +- [Mounting](src/Mechanical/mechanical.md#mounting) +- [Materials](src/Mechanical/mechanical.md#materials) +- [BOM (Bill of Materials)](src/Mechanical/mechanical.md#bom-bill-of-materials) +- [Resources](src/Mechanical/mechanical.md#resources) + - [Go Kart Suppliers](src/Mechanical/mechanical.md#go-kart-suppliers) + - [Tires](src/Mechanical/mechanical.md#tires-1) + +## [Safety](src/Safety/safety.md) + +- [General Safety](src/Safety/safety.md#general-safety) +- [Required Safety Components](src/Safety/safety.md#required-safety-components) +- [Remote Control](src/Safety/safety.md#remote-control) +- [Enforcement](src/Safety/safety.md#enforcement) +- [Resources](src/Safety/safety.md#resources) + - [Bodywork](src/Safety/safety.md#bodywork) + - [Long Range Control (Including Remote EStop)](src/Safety/safety.md#long-range-control-including-remote-estop) + +## [Race Procedure](src/Race_Procedure/race_procedure.md) + +- [Introduction](src/Race_Procedure/race_procedure.md#introduction) + - [What is the competition](src/Race_Procedure/race_procedure.md#what-is-the-competition) + - [Administrative](src/Race_Procedure/race_procedure.md#administrative) + - [Electrical](src/Race_Procedure/race_procedure.md#electrical) + - [Software](src/Race_Procedure/race_procedure.md#software) + - [Mechanical](src/Race_Procedure/race_procedure.md#mechanical) + - [Safety](src/Race_Procedure/race_procedure.md#safety) + - [Race Procedure](src/Race_Procedure/race_procedure.md#race-procedure) + - [Appendix](src/Race_Procedure/race_procedure.md#appendix) + +## [Appendix](src/Appendix/Appendix.md) \ No newline at end of file diff --git a/src/Overview.md b/src/Overview.md index e13eeab..d8ce54e 100644 --- a/src/Overview.md +++ b/src/Overview.md @@ -3,11 +3,3 @@ This repository contains the development pages and official document for the Autonomous Karting Series Competition Rules. The individual sections of the rules have a folder with a markdown file for development and discussion purposes. The official document will be a protected latex file that requires approval to edit and modify. Development Rulebook can be seen [here](https://rules.autonomouskartingseries.com/) - -## Commands - -For full documentation visit [mdbook](https://rust-lang.github.io/mdBook/). - -* `mdbook serve --open` - Start the live-reloading docs server. -* `mdbook build` - Build the documentation site. -* `mdbook help` - Print a help message.