Update theme and competitions page

AutoDRIVE-Ecosystem · Jul 18, 2024 · ca28ec1 · ca28ec1
1 parent dbe6d8a
commit ca28ec1
Show file tree

Hide file tree

Showing 6 changed files with 155 additions and 158 deletions.
diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css
@@ -1,7 +1,25 @@
+/* COLORS */
+/* Style */
+:root {
+    --md-primary-fg-color: #008DD2;
+    --md-accent-fg-color: #008DD2;
+    --md-primary-fg-color--dark: #434242;
+}
+/* Heading */
+.md-typeset h1,
+.md-typeset h2,
+.md-typeset h3 {
+    color: #008DD2;
+}
+/* Links */
+.md-content {
+    --md-typeset-a-color: #008DD2;
+}
+
+/* TABLES */
 .md-typeset__table {
     min-width: 100%;
- }
-
- .md-typeset table:not([class]) {
-     display: table;
- }
+}
+.md-typeset table:not([class]) {
+    display: table;
+}
diff --git a/docs/competitions.md b/docs/competitions.md
diff --git a/docs/competitions/f1tenth-sim-racing-cdc-2024.md b/docs/competitions/f1tenth-sim-racing-cdc-2024.md
@@ -0,0 +1,55 @@
+# F1TENTH Sim Racing League @ CDC 2024
+
+=== "About"
+
+    <p align="justify">
+        **F1TENTH Autonomous Racing** is a semi-regular competition organized by an international community of researchers, engineers, and autonomous systems enthusiasts. The teams participating in **21st F1TENTH Autonomous Grand Prix** at CDC 2024 will write software for a 1:10 scaled autonomous race car to fulfill the objectives for the competition: ***drive fast but don’t crash!***
+    </p>
+
+    <div class="grid" markdown>
+    <p align="justify">
+        This year, we are organizing the first ever **F1TENTH Sim Racing League** leveraging the [AutoDRIVE Ecosystem](https://autodrive-ecosystem.github.io). The main focus of the Sim Racing League is a virtual competition with simulated cars and environments. Each team will be provided with the F1TENTH digital twin simulator and have to write the software for their car. For the competition, teams first take part in a qualification session, where they demonstrate the ability to complete multiple laps without colliding with the track bounds at run time. This is followed by a time attack race, where teams compete against the clock to secure a position on the leaderboard. Since vehicles and simulator are standardized, teams must develop robust perception, planning, and control algorithms that can deal with the uncertainties of a new track.
+    </p>
+    <iframe width="560" height="315" src="https://www.youtube.com/embed/Rq7Wwcwn1uk?si=ngvop2-SfJJOIjWJ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+    </div>
+
+=== "Organizers"
+
+    - Venkat Krovi
+    - Rahul Mangharam
+    - Chinmay Samak
+    - Tanmay Samak
+    - Ahmad Amine
+
+=== "Timeline"
+
+    !!! warning
+        Timeline is subject to change.
+
+    |          DATE         | SIM RACING LEAGUE          |
+    |:----------------------|:---------------------------|
+    | Aug 01, 2024          | Registration Opens         |
+    | Oct 30, 2024          | Registration Closes        |
+    | Oct 22, 2024          | Orientation 1              |
+    | Nov 19, 2024          | Orientation 2              |
+    | Nov 30 – Dec 01, 2024 | Qualification Round        |
+    | Dec 02, 2024          | Competition Track Released |
+    | Dec 07 – Dec 08, 2024 | Final Race                 |
+    | Dec 09, 2024          | Results Declared           |
+
+    -	**Registration:** Teams register for the sim racing league.
+    -	**Orientation 1:** Organizers will explain the competition rules and guidelines, and demonstrate how to use the simulation framework.
+    -	**Orientation 2:** Organizers will check progress of the participating teams and help with any technical difficulties.
+    -	**Qualification Round:** Teams will demonstrate successful completion of 10 laps around the practice track provided ahead of time.
+    -	**Competition Track Released:** We will release the actual "competition track", which will be used for the final race. This track may be then replicated in the physical race as well.
+    -	**Final Race:** We will collect Docker containers from teams, with their algorithms and connect them to the AutoDRIVE Simulator container. Performance metrics of each team will be recorded.
+    -	**Results Declared:** Standings of all the teams will be released.
+
+=== "Resources"
+    Coming soon.
+
+=== "Registration"
+    Coming soon.
+
+=== "Results"
+    Coming soon.
diff --git a/docs/competitions/f1tenth-sim-racing-iros-2024.md b/docs/competitions/f1tenth-sim-racing-iros-2024.md
@@ -0,0 +1,64 @@
+# F1TENTH Sim Racing League @ IROS 2024
+
+=== "About"
+
+    <p align="justify">
+        **F1TENTH Autonomous Racing** is a semi-regular competition organized by an international community of researchers, engineers, and autonomous systems enthusiasts. The teams participating in **21st F1TENTH Autonomous Grand Prix** at IROS 2024 will write software for a 1:10 scaled autonomous race car to fulfill the objectives for the competition: ***drive fast but don’t crash!***
+    </p>
+
+    <div class="grid" markdown>
+    <p align="justify">
+        This year, we are organizing the first ever **F1TENTH Sim Racing League** leveraging the [AutoDRIVE Ecosystem](https://autodrive-ecosystem.github.io). The main focus of the Sim Racing League is a virtual competition with simulated cars and environments. Each team will be provided with the F1TENTH digital twin simulator and have to write the software for their car. For the competition, teams first take part in a qualification session, where they demonstrate the ability to complete multiple laps without colliding with the track bounds at run time. This is followed by a time attack race, where teams compete against the clock to secure a position on the leaderboard. Since vehicles and simulator are standardized, teams must develop robust perception, planning, and control algorithms that can deal with the uncertainties of a new track.
+    </p>
+    <iframe width="560" height="315" src="https://www.youtube.com/embed/Rq7Wwcwn1uk?si=ngvop2-SfJJOIjWJ" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+    </div>
+
+=== "Organizers"
+
+    - Rahul Mangharam
+    - Johannes Betz
+    - Venkat Krovi
+    - Ahmad Amine
+    - Hongrui Zheng
+    - Chinmay Samak
+    - Tanmay Samak
+    - Fabio Bonsignorio
+    - Enrica Zereik
+    - Bilal Hassan
+    - Bushra Alshehhi
+    - Fady Alnajjar
+    - Majd Khonji
+    - Hamad Karaki
+
+=== "Timeline"
+
+    !!! warning
+        Timeline is subject to change.
+
+    |          DATE         | SIM RACING LEAGUE          |
+    |:----------------------|:---------------------------|
+    | Jul 22, 2024          | Registration Opens         |
+    | Aug 30, 2024          | Registration Closes        |
+    | Aug 20, 2024          | Orientation 1              |
+    | Sep 17, 2024          | Orientation 2              |
+    | Sep 28 – Sep 29, 2024 | Qualification Round        |
+    | Sep 30, 2024          | Competition Track Released |
+    | Oct 05 – Oct 06, 2024 | Final Race                 |
+    | Oct 07, 2024          | Results Declared           |
+
+    -	**Registration:** Teams register for the sim racing league.
+    -	**Orientation 1:** Organizers will explain the competition rules and guidelines, and demonstrate how to use the simulation framework.
+    -	**Orientation 2:** Organizers will check progress of the participating teams and help with any technical difficulties.
+    -	**Qualification Round:** Teams will demonstrate successful completion of 10 laps around the practice track provided ahead of time.
+    -	**Competition Track Released:** We will release the actual "competition track", which will be used for the final race. This track may be then replicated in the physical race as well.
+    -	**Final Race:** We will collect Docker containers from teams, with their algorithms and connect them to the AutoDRIVE Simulator container. Performance metrics of each team will be recorded.
+    -	**Results Declared:** Standings of all the teams will be released.
+
+=== "Resources"
+    Coming soon.
+
+=== "Registration"
+    Coming soon.
+
+=== "Results"
+    Coming soon.
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,3 @@
-<head>
-  <link rel="shortcut icon" type="image/png" href="favicon.png">
-</head>
-
 <img src="assets/images/AutoDRIVE-Banner.jpg">
 
 <p align="center">

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -11,7 +11,7 @@ repo_name: Tinker-Twins/AutoDRIVE
 repo_url: https://github.com/Tinker-Twins/AutoDRIVE
 
 # Copyright
-copyright: Copyright &copy; 2024 Tinker Twins
+copyright: Copyright &copy; 2024 <a href="https://tinker-twins.github.io">Tinker Twins</a>
 
 # Configuration
 theme:
@@ -48,13 +48,13 @@ theme:
   language: en
   palette:
     - scheme: default
-      primary: white
+      primary: stylesheets/extra.css
       accent: light blue
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
     - scheme: slate
-      primary: grey
+      primary: stylesheets/extra.css
       accent: light blue
       toggle:
         icon: material/brightness-4
@@ -63,7 +63,7 @@ theme:
     text: Roboto
     code: Roboto Mono
   favicon: assets/favicon.png
-  logo: assets/images/AutoDRIVE-Extended-Logo-Light.png
+  logo: assets/favicon.png
 
 # Customization
 extra_css:
@@ -86,6 +86,7 @@ plugins:
 
 # Additional configuration
 extra:
+  generator: false
   status:
     new: Recently added
     deprecated: Deprecated
@@ -156,4 +157,11 @@ markdown_extensions:
           case: lower
   - pymdownx.tasklist:
       custom_checkbox: true
-  - pymdownx.tilde
+  - pymdownx.tilde
+
+# Page tree
+nav:
+  - HOME: index.md
+  - COMPETITIONS:
+    - F1TENTH @ IROS 2024: competitions/f1tenth-sim-racing-iros-2024.md
+    - F1TENTH @ CDC 2024: competitions/f1tenth-sim-racing-cdc-2024.md