Skip to content

Commit ae31755

Browse files
authored
Merge pull request #333 from acharraggi/fix-index
fix primary grid accessibility issue on index and personal pages.
2 parents a3d1600 + 10d319d commit ae31755

File tree

7 files changed

+477
-249
lines changed

7 files changed

+477
-249
lines changed

Diff for: docs/source/_static/js/adjust-css-vars.js

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
$(document).ready(function () {
2+
var r = document.querySelector(':root');
3+
r.style.setProperty('--sd-color-secondary', '#F57E25'); /* set grid secondary headers to the FTC color */
4+
});

Diff for: docs/source/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -328,6 +328,7 @@ def setup(app):
328328
app.add_css_file("css/ftc-rtd.css")
329329
#app.add_css_file("css/ftc-rtl.css")
330330
app.add_js_file("js/external-links-new-tab.js")
331+
app.add_js_file("js/adjust-css-vars.js")
331332

332333
# Set Cookie Banner to disabled by default
333334
cookiebanner_enabled = False

Diff for: docs/source/index.rst

+35-89
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
.. meta::
22
:title: FIRST Tech Challenge Documentation
33
:description: The official home of FIRST Tech Challenge Documentation.
4-
: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
4+
: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
55

66
*FIRST* Tech Challenge documentation
77
====================================
88

9-
*FIRST* Tech Challenge is a robotics program for middle and high school
10-
students. It’s way more than building robots, see
11-
:doc:`About the 𝘍𝘐𝘙𝘚𝘛 Tech Challenge <overview/ftcoverview>`
12-
to see why.
9+
Welcome to the *FIRST®* Tech Challenge Documentation! This website contains everything you need to know to create a competition robot!
10+
There is information and tutorials on how to use the *FIRST* Tech Challenge software and robot control system.
11+
There is also information for coaches and mentors.
1312

14-
.. note::
15-
16-
This project is under active development. Anything contained herein is for
17-
informational purposes only; while this documentation is intended to support
18-
teams and in some way provide context to game rules, the game rules supercede
19-
all documentation found here. If you have feedback about this project,
20-
please use our :doc:`feedback form <ftc_docs/form/form>`.
13+
*FIRST* Tech Challenge is a robotics program for middle and high school students.
14+
It’s way more than building robots, see :doc:`About the FIRST Tech Challenge <overview/ftcoverview>`
15+
and :doc:`gracious_professionalism/gp` to see why.
2116

2217
.. toctree::
2318
:hidden:
@@ -44,8 +39,8 @@ to see why.
4439
game_specific_resources/blog/blog
4540
tech_tips/tech-tips
4641
ai/innovation_corner/innovation-corner
47-
manuals/game_manuals/game_manuals
48-
Game Q&A Forum <game_specific_resources/ftcqa/ftcqa>
42+
Competition Manual <manuals/game_manuals/game_manuals>
43+
Game Q&A System <game_specific_resources/ftcqa/ftcqa>
4944
game_specific_resources/playing_field_resources/playing_field_resources
5045
Field Coordinate System <game_specific_resources/field_coordinate_system/field-coordinate-system>
5146

@@ -122,71 +117,26 @@ to see why.
122117

123118
.. Add Contrib Section here when added
124119
125-
.. rst-class:: center
126-
127-
**I AM A...**
120+
**I am a...**
128121

129-
.. grid:: 1 2 2 4
130-
:gutter: 2
122+
- :doc:`New Team <persona_pages/rookie_teams/rookie_teams>` - New Teams may not know where to start. This is the way!
131123

132-
.. grid-item-card:: New Team Resources
133-
:link: persona_pages/rookie_teams/rookie_teams
134-
:link-type: doc
135-
:class-header: sd-bg-primary font-weight-bold sd-text-white
136-
:class-body: sd-text-left body
124+
- :doc:`Returning Team <persona_pages/veteran_teams/veteran_teams>` - Returning Teams looking for resources can look here.
137125

138-
New Team
139-
140-
^^^
126+
- :doc:`Coach <persona_pages/coach_admin/coach_admin>` - Coaches looking for help or Team Administrative Resources can look here.
141127

142-
New Teams may not know where to start. This is the way!
128+
- :doc:`Mentor <persona_pages/mentor_tech/mentor_tech>` - Technical Mentors looking for Technical Resources should look here first!
143129

144-
.. grid-item-card:: Returning Team Resources
145-
:link: persona_pages/veteran_teams/veteran_teams
146-
:link-type: doc
147-
:class-header: sd-bg-primary font-weight-bold sd-text-white
148-
:class-body: sd-text-left
149-
150-
Returning Team
151-
152-
^^^
153-
154-
Returning Teams looking for resources can look here.
155-
156-
.. grid-item-card:: Coach Resources
157-
:link: persona_pages/coach_admin/coach_admin
158-
:link-type: doc
159-
:class-header: sd-bg-primary font-weight-bold sd-text-white
160-
:class-body: sd-text-left
161-
162-
Coach (Admin)
163-
164-
^^^
165-
166-
Coaches looking for Team Administrative Resources can
167-
look here for help.
168-
169-
.. grid-item-card:: Mentor Resources
170-
:link: persona_pages/mentor_tech/mentor_tech
171-
:link-type: doc
172-
:class-header: sd-bg-primary font-weight-bold sd-text-white
173-
:class-body: sd-text-left
174-
175-
Mentor (Technical)
176-
177-
^^^
178-
179-
Technical Mentors looking for Technical Resources
180-
should look here first!
130+
The main menu contains links to the top level content. The following are quick links organized by topic.
181131

182132
.. grid:: 1 2 2 2
183133
:gutter: 2
184134

185135
.. grid-item-card::
186-
:class-header: sd-bg-secondary font-weight-bold sd-text-white
136+
:class-header: sd-bg-secondary font-weight-bold sd-text-black
187137
:class-body: sd-text-left
188138

189-
Programming Quick Links
139+
Programming Links
190140

191141
^^^
192142

@@ -236,16 +186,6 @@ to see why.
236186

237187
AprilTags
238188

239-
.. div:: col-sm pl-1 pr-1
240-
241-
.. button-ref:: programming_resources/vision/tensorflow_cs_2023/tensorflow-cs-2023
242-
:ref-type: doc
243-
:color: black
244-
:outline:
245-
:expand:
246-
247-
TensorFlow
248-
249189
.. div:: col-sm pl-1 pr-1
250190

251191
.. button-ref:: programming_resources/index
@@ -257,7 +197,7 @@ to see why.
257197
All Resources
258198

259199
.. grid-item-card::
260-
:class-header: sd-bg-secondary font-weight-bold sd-text-white
200+
:class-header: sd-bg-secondary font-weight-bold sd-text-black
261201
:class-body: sd-text-left
262202

263203
Control System Links
@@ -311,7 +251,7 @@ to see why.
311251
Hardware Configuration
312252

313253
.. grid-item-card::
314-
:class-header: sd-bg-secondary font-weight-bold sd-text-white
254+
:class-header: sd-bg-secondary font-weight-bold sd-text-black
315255
:class-body: sd-text-left
316256

317257
Software Development Kit (SDK)
@@ -343,7 +283,7 @@ to see why.
343283
:outline:
344284
:expand:
345285

346-
SDK GitHub Repository
286+
SDK GitHub Repository (external)
347287

348288
.. div:: col-sm pl-1 pr-1
349289

@@ -352,7 +292,7 @@ to see why.
352292
:outline:
353293
:expand:
354294

355-
SDK Releases
295+
SDK Releases (external)
356296

357297
.. div:: col-sm pl-1 pr-1
358298

@@ -361,18 +301,18 @@ to see why.
361301
:outline:
362302
:expand:
363303

364-
Javadoc Documentation
304+
Javadoc Documentation (external)
365305

366306
.. grid-item-card::
367-
:class-header: sd-bg-secondary font-weight-bold sd-text-white
307+
:class-header: sd-bg-secondary font-weight-bold sd-text-black
368308
:class-body: sd-text-left
369309

370-
Game Manual Links
310+
Game Links
371311

372312
^^^
373313

374314
Be sure you're following all of the rules of the competition!
375-
Game Manuals and Q&A are essential documents.
315+
The Competition Manual is an essential document.
376316

377317
+++
378318

@@ -386,7 +326,7 @@ to see why.
386326
:outline:
387327
:expand:
388328

389-
Game Manuals
329+
Competition Manual
390330

391331
.. div:: col-sm pl-1 pr-1
392332

@@ -396,14 +336,20 @@ to see why.
396336
:outline:
397337
:expand:
398338

399-
Field Manuals
400-
401339
.. div:: col-sm pl-1 pr-1
402340

403341
.. button-link:: https://ftc-qa.firstinspires.org/
404342
:color: black
405343
:outline:
406344
:expand:
407345

408-
Game Q&A System
346+
Game Question and Answer System (external)
347+
348+
.. note::
349+
350+
This project is under active development. Anything contained herein is for
351+
informational purposes only; while this documentation is intended to support
352+
teams and in some way provide context to game rules, the game rules supercede
353+
all documentation found here. If you have feedback about this project,
354+
please use our :doc:`feedback form <ftc_docs/form/form>`.
409355

0 commit comments

Comments
 (0)