Skip to content

Commit f18ca0f

Browse files
authored
Enable beta docs for 2025 (wpilibsuite#2786)
1 parent d7bda9b commit f18ca0f

File tree

5 files changed

+32
-15
lines changed

5 files changed

+32
-15
lines changed

source/conf.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,6 @@
178178
# This pattern also affects html_static_path and html_extra_path.
179179
exclude_patterns = [
180180
"docs/yearly-overview/2020-Game-Data.rst",
181-
"docs/beta/*",
182181
]
183182

184183
# Specify the master doc file, AKA our homepage

source/docs/beta/beta-getting-started/accessing-the-beta-project.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
Accessing the Beta Project
44
==========================
55

6-
The Beta Test project is located at: `<https://github.com/wpilibsuite/2024Beta>`__.
6+
The Beta Test project is located at: `<https://github.com/wpilibsuite/2025Beta>`__.
77

88
Signing In
99
----------
1010

1111
.. image:: images/accessing-the-beta-project/login.png
1212
:alt: Logging in to the GitHub site.
1313

14-
Open your web browser and browse to `<https://github.com/wpilibsuite/2024Beta>`__. Near the top right corner of the page, click "Sign In" (if the Sign-In box does not automatically appear), enter your username and password and click "Sign In". If you have two-factor authenticatio enabled you may need to complete an action on your mobile device to verify your log in attempt.
14+
Open your web browser and browse to `<https://github.com/wpilibsuite/2025Beta>`__. Near the top right corner of the page, click "Sign In" (if the Sign-In box does not automatically appear), enter your username and password and click "Sign In". If you have two-factor authenticatio enabled you may need to complete an action on your mobile device to verify your log in attempt.
1515

1616
The Project Homepage
1717
--------------------
@@ -21,7 +21,7 @@ The Project Homepage
2121

2222
The project homepage contains a ReadMe file. Throughout the beta, the ReadMe section may be updated with the latest information from the *FIRST* technical staff. The top ribbon contains tabs allowing you to navigate to the different sections of the project:
2323

24-
2. Code - The Code tab will take you to the ReadMe with Beta announcements as well as allow you to access file releases using the "Releases" section on the right hand side of the screen.
25-
1. Issues - The Issues tab is where the bug tracker for the project is located.
26-
4. Discussions - The Discussions tab contains a forum which will allow teams to post questions or discussions about the Beta test, software or documentation. Task reports will also be posted here.
27-
3. Wiki - the Wiki tab will contain any documents to be distributed to Beta teams. We do not currently expect to use this but if there is any documentation that we want to restrict to Beta Teams only it will be posted here.
24+
1. Code - The Code tab will take you to the ReadMe with Beta announcements as well as allow you to access file releases using the "Releases" section on the right hand side of the screen.
25+
2. Issues - The Issues tab is where the bug tracker for the project is located.
26+
3. Discussions - The Discussions tab contains a forum which will allow teams to post questions or discussions about the Beta test, software or documentation. Task reports will also be posted here.
27+
4. Wiki - the Wiki tab will contain any documents to be distributed to Beta teams. We do not currently expect to use this but if there is any documentation that we want to restrict to Beta Teams only it will be posted here.

source/docs/beta/tasks/beta-task-overview.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,22 @@ The purpose of Task 0 is to complete some housekeeping tasks and familiarize you
1313
1. Beta Test Tools and Documentation Familiarization
1414

1515

16-
Task 1 - Install Software (Targeted Completion 10/30/2023)
16+
Task 1 - Install Software (Targeted Completion 10/28/2024)
1717
----------------------------------------------------------
1818

1919
The purpose of Task 1 is to complete installation of the new Control System software. This task consists of 1 Objective
2020

21-
1. Install the necessary software for your assigned Beta Test language (LabVIEW or VSCode + plugins, NI FRC Game Tools, CTRE installer if using CANTalon SRX, REV installer if using SPARK MAX or new REV hardware)
21+
1. Install the necessary software for your assigned Beta Test language (LabVIEW or VSCode + plugins, NI FRC Game Tools, and any vendor libraries e.g. CTRE Phoenix, REVLib, etc)
2222

23-
Task 2 - Basic Benchtop Test (Targeted Completion 11/6/2023)
23+
Task 2 - Basic Benchtop Test (Targeted Completion 11/4/2024)
2424
------------------------------------------------------------
2525

2626
The purpose of Task 2 is to get the base new Control System software set up and running. This helps minimize complexity to ease debugging of any issues that do occur. In this task you will set up the development environment for your programming language, configure the roboRIO, load and debug a simple program. This Task consists of 2 Objectives:
2727

2828
1. Configure the roboRIO
2929
2. Create, Build and Load Default Program
3030

31-
Task 3 - Port Previous Robot Code (Targeted Completion 11/20/2023)
31+
Task 3 - Port Previous Robot Code (Targeted Completion 11/18/2024)
3232
------------------------------------------------------------------
3333

3434
The purpose of Task 3 is to port the previous year's robot code with the new Control System software and bring it to full functionality. This Task consists of 2 Objectives and 1 Optional Objective:
@@ -37,12 +37,14 @@ The purpose of Task 3 is to port the previous year's robot code with the new Con
3737
2. Wireless Operation of FRC Robot
3838
3. (Optional) Play with robot at offseason event
3939

40-
Task 4 - New Code and Advanced Feature Testing (Targeted Completion 12/4/2023)
40+
Task 4 - New Code and Advanced Feature Testing (Targeted Completion 12/6/2024)
4141
------------------------------------------------------------------------------
4242

4343
Note: Objectives in Task 4 may be completed in any order.
4444

4545
The purpose of Task 4 is to write new code in order to test features and functionality of the new Control System software. While we have written up a number of ideas, please feel free to come up with your own and report on what you tried/are trying and how it went.
4646

47-
1. Java/C++ - SysID (currently work in progress)
47+
1. Java: Use :doc:`Epilogue annotation logging </docs/software/telemetry/robot-telemetry-with-annotations>`
48+
2. Java: Use the re-written :doc:`Java units library </docs/software/basic-programming/java-units>`
49+
3. Java/C++: Utilize the new Vendor Dependency manager in Visual Studio Code
4850

source/docs/beta/tasks/task-4-new-features.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,16 @@ The purpose of this task is to test any newly developed or heavily modified feat
1212

1313
**LabVIEW**
1414

15-
**C++/Java**
15+
**Java**
1616

17-
- SysID (when available)
17+
- Use :doc:`Epilogue annotation logging </docs/software/telemetry/robot-telemetry-with-annotations>`
18+
- Use the re-written :doc:`Java units library </docs/software/basic-programming/java-units>`
19+
20+
**Java/C++**
21+
22+
- Utilize the new Vendor Dependency manager in Visual Studio Code
23+
24+
**Java/C++/Python**
1825

1926
Desired Feedback
2027
----------------

source/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,15 @@ Community translations can be found in a variety of languages in the bottom-left
326326

327327
View article
328328

329+
.. toctree::
330+
:maxdepth: 1
331+
:titlesonly:
332+
:caption: FRC Beta Test
333+
:hidden:
334+
335+
docs/beta/beta-getting-started/index
336+
docs/beta/tasks/index
337+
329338
.. toctree::
330339
:maxdepth: 1
331340
:titlesonly:

0 commit comments

Comments
 (0)