Skip to content

Restructure the Match Play/Test section - #131

Merged
alexherreid merged 2 commits into
FIRSTRobotics:masterfrom
stevep001:speterson/match-play-restructure
Aug 7, 2026
Merged

Restructure the Match Play/Test section#131
alexherreid merged 2 commits into
FIRSTRobotics:masterfrom
stevep001:speterson/match-play-restructure

Conversation

@stevep001

@stevep001 stevep001 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

This reorganizes the Match Play section so its landing page works as a chooser, and cleans up the pages it points at. Each tab on Match Play is now a separate topic.

This restructuring is being put in place to support a new help feature in Event Manager.

Match Play/Test landing page

Carries the Match Play screen shot and a one- or two-sentence description of each of the three sections of the screen, followed by links to each tab. This is where FMS help will land from Match Play.

Renames

  • Interface → Match Play. The page had a redundant "Match Play" sub-heading under a title of "Interface"; the sub-heading is gone and its content is now the page lead. The label is match-play (was match-play-interface).
  • Match Control (FCUI) → Match State. This more accurately describes the top section, which is both about control and state.

Bypass vs DQ vs Red Card

Folded into Match Play as a section immediately after Robot Status, which is where the Byp, DQ and card-state controls it describes are documented. This used to be a standalone page and didn't make sense in the new page hierarchy.

One page per tab

The combined Tabs page is split into Schedule, Video Switch, Message and Options pages, matching the Score and Status pages that already existed. All six are now children of Match Play in the table of contents rather than siblings of it.

Match Test

Copy edited — it had a grammar error, two stacked "Note that" sentences, and said the same thing about schedules twice. Also adds a Naming a Test Match section covering the description box in the Prestart Enter Teams dialog and where the name appears on the Audience Display.

Prestart

The Prestart entry said only that it "can be cancelled if necessary while it's running." It now describes the Prestart Cancel button, the confirmation prompt when backing out of a completed Prestart, and what "Back Out" means — a term the Reset Network note already referred to without ever defining.

Redirects

Two published URLs go away in this change, so rediraffe is enabled to redirect them rather than let them 404. It was already pinned in source/requirements.txt but had never been switched on.

Old URL Now goes to
match-play-test/tabs.html the Match Play/Test landing page
match-play-test/bypass-vs-dq-vs-red-card.html Match Play

rediraffe_redirects in conf.py is where to add an entry whenever a page is renamed or removed from now on.


Builds clean with -W --keep-going.

Steve Peterson added 2 commits August 7, 2026 11:16
Match Play is documented across a page for the upper interface and several
for the tabs, so FMS help could only ever land on one of them -- and the
selected tab always won, leaving the interface page unreachable. This
reorganizes the section so its landing page works as a chooser, and cleans
up the pages it points at.

- Match Play/Test index now carries the screen shot and a short description
  of the three sections of the screen, with links to each tab.
- "Interface" is retitled "Match Play"; the redundant sub-heading under it
  is gone and its label is now match-play.
- "Match Control (FCUI)" is retitled "Match State". The FCUI acronym is
  retired throughout the manual.
- "Bypass vs DQ vs Red Card" folds into Match Play beside the Byp, DQ and
  card controls it describes, keeping its label.
- The combined Tabs page splits into one page per tab (Schedule, Video
  Switch, Message, Options), matching the existing Score and Status pages.
  These are now children of Match Play in the table of contents.
- Match Test is copy edited and gains a section on naming a test match.
- Prestart now documents Prestart Cancel and what "Back Out" means.
Splitting the Tabs page and folding Bypass vs DQ vs Red Card into Match Play
removed two published URLs. Enable rediraffe -- already pinned in
requirements.txt but never switched on -- so the old addresses redirect
instead of 404ing:

  tabs.html                     -> the Match Play/Test landing page
  bypass-vs-dq-vs-red-card.html -> Match Play
@alexherreid
alexherreid merged commit 6b4d665 into FIRSTRobotics:master Aug 7, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants