Merge pull request #333 from acharraggi/fix-index

fix primary grid accessibility issue on index and personal pages.
FIRST-Tech-Challenge · Jan 29, 2025 · ae31755 · ae31755
2 parents a3d1600 + 10d319d
commit ae31755
Show file tree

Hide file tree

Showing 7 changed files with 477 additions and 249 deletions.
diff --git a/docs/source/_static/js/adjust-css-vars.js b/docs/source/_static/js/adjust-css-vars.js
@@ -0,0 +1,4 @@
+$(document).ready(function () {
+  var r = document.querySelector(':root');
+  r.style.setProperty('--sd-color-secondary', '#F57E25'); /* set grid secondary headers to the FTC color */
+});
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -328,6 +328,7 @@ def setup(app):
     app.add_css_file("css/ftc-rtd.css")
     #app.add_css_file("css/ftc-rtl.css")
     app.add_js_file("js/external-links-new-tab.js")
+    app.add_js_file("js/adjust-css-vars.js")
 
 # Set Cookie Banner to disabled by default
 cookiebanner_enabled = False

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,23 +1,18 @@
 .. meta::
    :title: FIRST Tech Challenge Documentation
    :description: The official home of FIRST Tech Challenge Documentation.
-   :keywords: FTC Control System, Control Hub, TensorFlow, CENTERSTAGE, Blocks, OnBot Java, Android Studio, OpenCV, EasyOpenCV, AprilTags, FTC SDK, Robot Controller App, Driver Station App, Control Hub, Driver Hub, ftc-ml, IMU, Water Game
+   :keywords: FTC Control System, Blocks, OnBot Java, Android Studio, OpenCV, EasyOpenCV, AprilTags, FTC SDK, Robot Controller App, Driver Station App, Control Hub, Driver Hub, IMU, Water Game
 
 *FIRST* Tech Challenge documentation
 ====================================
 
-*FIRST* Tech Challenge is a robotics program for middle and high school
-students. It’s way more than building robots, see 
-:doc:`About the 𝘍𝘐𝘙𝘚𝘛 Tech Challenge <overview/ftcoverview>`
-to see why.
+Welcome to the *FIRST®* Tech Challenge Documentation! This website contains everything you need to know to create a competition robot!
+There is information and tutorials on how to use the *FIRST* Tech Challenge software and robot control system.
+There is also information for coaches and mentors.
 
-.. note::
-
-   This project is under active development. Anything contained herein is for 
-   informational purposes only; while this documentation is intended to support 
-   teams and in some way provide context to game rules, the game rules supercede 
-   all documentation found here. If you have feedback about this project, 
-   please use our :doc:`feedback form <ftc_docs/form/form>`.
+*FIRST* Tech Challenge is a robotics program for middle and high school students.
+It’s way more than building robots, see :doc:`About the FIRST Tech Challenge <overview/ftcoverview>`
+and :doc:`gracious_professionalism/gp` to see why.
 
 .. toctree::
    :hidden:
@@ -44,8 +39,8 @@ to see why.
    game_specific_resources/blog/blog
    tech_tips/tech-tips
    ai/innovation_corner/innovation-corner
-   manuals/game_manuals/game_manuals
-   Game Q&A Forum <game_specific_resources/ftcqa/ftcqa>
+   Competition Manual <manuals/game_manuals/game_manuals>
+   Game Q&A System <game_specific_resources/ftcqa/ftcqa>
    game_specific_resources/playing_field_resources/playing_field_resources
    Field Coordinate System <game_specific_resources/field_coordinate_system/field-coordinate-system>
 
@@ -122,71 +117,26 @@ to see why.
 
 .. Add Contrib Section here when added
 
-.. rst-class:: center
-
-**I AM A...**
+**I am a...**
 
-.. grid:: 1 2 2 4
-   :gutter: 2 
+- :doc:`New Team <persona_pages/rookie_teams/rookie_teams>` - New Teams may not know where to start. This is the way!
 
-   .. grid-item-card:: New Team Resources
-      :link: persona_pages/rookie_teams/rookie_teams
-      :link-type: doc
-      :class-header: sd-bg-primary font-weight-bold sd-text-white 
-      :class-body: sd-text-left body
+- :doc:`Returning Team <persona_pages/veteran_teams/veteran_teams>` - Returning Teams looking for resources can look here.
 
-      New Team 
-
-      ^^^
+- :doc:`Coach <persona_pages/coach_admin/coach_admin>` - Coaches looking for help or Team Administrative Resources can look here.
 
-      New Teams may not know where to start. This is the way!
+- :doc:`Mentor <persona_pages/mentor_tech/mentor_tech>` - Technical Mentors looking for Technical Resources should look here first!
 
-   .. grid-item-card:: Returning Team Resources
-      :link: persona_pages/veteran_teams/veteran_teams
-      :link-type: doc
-      :class-header: sd-bg-primary font-weight-bold sd-text-white 
-      :class-body: sd-text-left
-
-      Returning Team 
-
-      ^^^
-
-      Returning Teams looking for resources can look here.
-
-   .. grid-item-card:: Coach Resources
-      :link: persona_pages/coach_admin/coach_admin
-      :link-type: doc
-      :class-header: sd-bg-primary font-weight-bold sd-text-white 
-      :class-body: sd-text-left
-
-      Coach (Admin)
-
-      ^^^
-
-      Coaches looking for Team Administrative Resources can 
-      look here for help.
-
-   .. grid-item-card:: Mentor Resources
-      :link: persona_pages/mentor_tech/mentor_tech
-      :link-type: doc
-      :class-header: sd-bg-primary font-weight-bold sd-text-white 
-      :class-body: sd-text-left
-
-      Mentor (Technical)
-
-      ^^^
-
-      Technical Mentors looking for Technical Resources 
-      should look here first!
+The main menu contains links to the top level content. The following are quick links organized by topic.
 
 .. grid:: 1 2 2 2
    :gutter: 2
 
    .. grid-item-card:: 
-      :class-header: sd-bg-secondary font-weight-bold sd-text-white
+      :class-header: sd-bg-secondary font-weight-bold sd-text-black
       :class-body: sd-text-left 
 
-      Programming Quick Links
+      Programming Links
 
       ^^^
 
@@ -236,16 +186,6 @@ to see why.
 
                AprilTags
 
-         .. div:: col-sm pl-1 pr-1
-
-            .. button-ref:: programming_resources/vision/tensorflow_cs_2023/tensorflow-cs-2023
-               :ref-type: doc
-               :color: black
-               :outline:
-               :expand:
-
-               TensorFlow
-
          .. div:: col-sm pl-1 pr-1
 
             .. button-ref:: programming_resources/index
@@ -257,7 +197,7 @@ to see why.
                All Resources
 
    .. grid-item-card:: 
-      :class-header: sd-bg-secondary font-weight-bold sd-text-white
+      :class-header: sd-bg-secondary font-weight-bold sd-text-black
       :class-body: sd-text-left 
 
       Control System Links
@@ -311,7 +251,7 @@ to see why.
                Hardware Configuration
 
    .. grid-item-card:: 
-      :class-header: sd-bg-secondary font-weight-bold sd-text-white
+      :class-header: sd-bg-secondary font-weight-bold sd-text-black
       :class-body: sd-text-left 
 
       Software Development Kit (SDK)
@@ -343,7 +283,7 @@ to see why.
                :outline:
                :expand:
 
-               SDK GitHub Repository
+               SDK GitHub Repository (external)
 
          .. div:: col-sm pl-1 pr-1
 
@@ -352,7 +292,7 @@ to see why.
                :outline:
                :expand:
 
-               SDK Releases
+               SDK Releases (external)
 
          .. div:: col-sm pl-1 pr-1
 
@@ -361,18 +301,18 @@ to see why.
                :outline:
                :expand:
 
-               Javadoc Documentation
+               Javadoc Documentation (external)
 
    .. grid-item-card:: 
-      :class-header: sd-bg-secondary font-weight-bold sd-text-white
+      :class-header: sd-bg-secondary font-weight-bold sd-text-black
       :class-body: sd-text-left 
 
-      Game Manual Links
+      Game Links
 
       ^^^
 
       Be sure you're following all of the rules of the competition! 
-      Game Manuals and Q&A are essential documents.
+      The Competition Manual is an essential document.
 
       +++
 
@@ -386,7 +326,7 @@ to see why.
                :outline:
                :expand:
 
-               Game Manuals
+               Competition Manual
 
          .. div:: col-sm pl-1 pr-1
 
@@ -396,14 +336,20 @@ to see why.
                :outline:
                :expand:
 
-               Field Manuals
-
          .. div:: col-sm pl-1 pr-1
 
             .. button-link:: https://ftc-qa.firstinspires.org/
                :color: black
                :outline:
                :expand:
 
-               Game Q&A System
+               Game Question and Answer System (external)
+
+.. note::
+
+   This project is under active development. Anything contained herein is for 
+   informational purposes only; while this documentation is intended to support 
+   teams and in some way provide context to game rules, the game rules supercede 
+   all documentation found here. If you have feedback about this project, 
+   please use our :doc:`feedback form <ftc_docs/form/form>`.