Skip to content

Commit

Permalink
Adding Gitbook website for Rules (#1)
Browse files Browse the repository at this point in the history
* Initial rearranging

* Removing book

* Removing gitbook branch as trigger branch
  • Loading branch information
sisaha9 authored Nov 20, 2023
1 parent 4e238c0 commit ff15703
Show file tree
Hide file tree
Showing 15 changed files with 90 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/README.md
28 changes: 28 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: github pages

on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
deploy:
runs-on: ubuntu-latest
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v4
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v1
with:
mdbook-version: 'latest'
- run: mdbook build
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
# if: ${{ github.ref == 'refs/heads/master' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book
9 changes: 9 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[book]
authors = ["Siddharth Saha", "Andrew Goeden"]
language = "en"
multilingual = false
src = "src"
title = "Autonomous Karting Series Rulebook"

[output.html]
mathjax-support = true
22 changes: 22 additions & 0 deletions src/Administrative/administrative.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Administrative

## Who is allowed to compete
1. Teams are required to be affiliated with an Academic Institution.
2. A team can consist of members from more than one University, however any one person cannot be on multiple teams.

## Required Roles
1. All teams must establish at least one member as their Autonomous Safety Officer.
* The Autonomous Safety Office will ensure that their team’s kart is operating in a safe manner on and off track.
2. All teams must establish at least one Designated Driver.
* A Designated Driver is a separate person from a team’s Autonomous Safety Officer.
* A Designated Driver is responsible for driving the team’s kart as either a driver within the kart or when the kart is being operated remotely.

## Documentation Requirements from teams
1. All participants must sign and submit a liability waiver.
1. All teams must submit the required videos and design documentation before specified race deadlines.
2. Some events may require certain components and features to be demonstrated in person.
1. Teams must be able to demonstrate all components and features in person if requested.
2. Teams will be notified of specific demonstrations before the event.

## Jurisdiction of rules
1. All announcements and comments posted on the official website of the competition are to be considered part of the official ruleset
File renamed without changes.
File renamed without changes.
5 changes: 5 additions & 0 deletions src/Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Introduction

## What is the competition

The Autonomous Karting Series is a collegiate competition series in which teams design, build, and race autonomous electric go-karts.
File renamed without changes.
13 changes: 13 additions & 0 deletions src/Overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Overview

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://autonomous-karting-series.github.io/Rulebook/)

## 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.
File renamed without changes
File renamed without changes.
12 changes: 12 additions & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Summary

[Introduction](Introduction.md)
[Overview](Overview.md)

- [Administrative](Administrative/administrative.md)
- [Mechanical](Mechanical/mechanical.md)
- [Electrical](Electrical/electrical.md)
- [Race Procedure](Race_Procedure/race_procedure.md)
- [Safety](Safety/safety.md)
- [Software](Software/software.md)
- [Appendix](Appendix/appendix.md)
File renamed without changes.
File renamed without changes.

0 comments on commit ff15703

Please sign in to comment.