diff --git a/source/docs/contributing/frc-docs/style-guide.rst b/source/docs/contributing/frc-docs/style-guide.rst index ccd11f126e..3e4913aab7 100644 --- a/source/docs/contributing/frc-docs/style-guide.rst +++ b/source/docs/contributing/frc-docs/style-guide.rst @@ -36,7 +36,7 @@ Use ``.. math::`` for standalone equations and ``:math:`` for inline equations. Use literals for filenames, function, and variable names. -Use of the registered trademarks *FIRST*\ |reg| and FRC\ |reg| should follow the Policy from [this page](https://www.firstinspires.org/brand). Specifically, where possible (i.e. not nested inside other markup or in a document title), the first use of the trademarks should have the |reg| symbol and all instances of *FIRST* should be italicized. The |reg| symbol can be added by using ``.. include:: `` at the top of the document and then using ``*FIRST*\ |reg|`` or ``FRC\ |reg|``. +Use of the registered trademarks *FIRST*\ |reg| and FRC\ |reg| should follow the Policy from [this page](https://www.firstinspires.org/about/brand). Specifically, where possible (i.e. not nested inside other markup or in a document title), the first use of the trademarks should have the |reg| symbol and all instances of *FIRST* should be italicized. The |reg| symbol can be added by using ``.. include:: `` at the top of the document and then using ``*FIRST*\ |reg|`` or ``FRC\ |reg|``. Commonly used terms should be added to the :ref:`docs/software/frc-glossary:FRC Glossary`. You can reference items in the glossary by using ``:term:`deprecated```. diff --git a/source/docs/controls-overviews/control-system-hardware.rst b/source/docs/controls-overviews/control-system-hardware.rst index 856f527e67..89e788f747 100644 --- a/source/docs/controls-overviews/control-system-hardware.rst +++ b/source/docs/controls-overviews/control-system-hardware.rst @@ -116,7 +116,7 @@ The [Rev ATO Circuit Breakers](https://www.revrobotics.com/content/docs/REV-11-1 The power supply for an FRC robot is a single 12V 18Ah Sealed Lead Acid (SLA) battery, capable of meeting the high current demands of an FRC robot. For more information, see the :ref:`Robot Battery page. ` -.. note:: Multiple battery part numbers may be legal, consult the [FRC Manual](https://www.firstinspires.org/resource-library/frc/competition-manual-qa-system) for a complete list. +.. note:: Multiple battery part numbers may be legal, consult the [FRC Manual](https://www.firstinspires.org/resources/library/frc/season-materials?view=calendar) for a complete list. ## Robot Signal Light diff --git a/source/docs/hardware/hardware-basics/wiring-pneumatics-pcm.rst b/source/docs/hardware/hardware-basics/wiring-pneumatics-pcm.rst index 6dafc7cd17..3b02816ae1 100644 --- a/source/docs/hardware/hardware-basics/wiring-pneumatics-pcm.rst +++ b/source/docs/hardware/hardware-basics/wiring-pneumatics-pcm.rst @@ -2,7 +2,7 @@ This page describes wiring pneumatics with the CTRE Pneumatic Control Module (PCM). For instructions on wiring pneumatics with the REV Pneumatic Hub (PH) see :doc:`this page `. -.. hint:: For pneumatics safety & mechanical requirements, consult this year's Robot Construction rules. For mechanical design guidelines, the FIRST Pneumatics Manual is located [here](https://www.firstinspires.org/sites/default/files/uploads/resource_library/frc/technical-resources/frc_pneumatics_manual.pdf) +.. hint:: For pneumatics safety & mechanical requirements, consult this year's Robot Construction rules. For mechanical design guidelines, refer to the [FIRST Pneumatics Manual](https://info.firstinspires.org/hubfs/web/program/frc/resources/pneumatics-manual.pdf). ## Wiring Overview diff --git a/source/docs/hardware/hardware-basics/wiring-pneumatics-ph.rst b/source/docs/hardware/hardware-basics/wiring-pneumatics-ph.rst index 7ce58842ae..f1eef37c70 100644 --- a/source/docs/hardware/hardware-basics/wiring-pneumatics-ph.rst +++ b/source/docs/hardware/hardware-basics/wiring-pneumatics-ph.rst @@ -2,7 +2,7 @@ This page describes wiring pneumatics with the REV Pneumatic Hub (:term:`PH`). For instructions on wiring pneumatics with the CTRE Pneumatic Control Module (:term:`PCM`) see :doc:`this page `. -.. hint:: For pneumatics safety & mechanical requirements, consult this year's Robot Construction rules. For mechanical design guidelines, the FIRST Pneumatics Manual is located [here](https://www.firstinspires.org/sites/default/files/uploads/resource_library/frc/technical-resources/frc_pneumatics_manual.pdf) +.. hint:: For pneumatics safety & mechanical requirements, consult this year's Robot Construction rules. For mechanical design guidelines, refer to the [FIRST Pneumatics Manual](https://info.firstinspires.org/hubfs/web/program/frc/resources/pneumatics-manual.pdf). .. raw:: html diff --git a/source/docs/legal/privacy-policy.rst b/source/docs/legal/privacy-policy.rst index 92a266df2f..6e3d793a80 100644 --- a/source/docs/legal/privacy-policy.rst +++ b/source/docs/legal/privacy-policy.rst @@ -8,7 +8,7 @@ WPILib-developed desktop applications do not collect personal information. They The WPILib libraries do not collect personal information. When run on the roboRIO, the libraries collect limited metrics data (“usage reporting”) regarding what pieces of the libraries are used by the deployed software (user-written code linked to the WPILib libraries). Only when the robot code is running and connected to the competition field at a FIRST Robotics Competition event is this information shared with and stored by the Field Management System. This information is associated solely with the FRC team and not with any individual. An anonymized (team number removed) version of this metrics data is publicly shared by FIRST after each competition season, and is used to inform future development of library features. -[FIRST Privacy Policy](https://www.firstinspires.org/about/privacy-policy). +[FIRST Privacy Policy](https://www.firstinspires.org/privacy-policy). ## Third-Party Data Collection diff --git a/source/docs/romi-robot/index.rst b/source/docs/romi-robot/index.rst index 900376ad18..72705d7c16 100644 --- a/source/docs/romi-robot/index.rst +++ b/source/docs/romi-robot/index.rst @@ -1,8 +1,10 @@ +.. include:: + # Getting Started with Romi -The Romi is a small and inexpensive robot designed for learning about programming FRC robots. All the same tools used for programming full-sized FRC robots can be used to program the Romi. The Romi comes with two drive motors with integrated wheel encoders. It also includes an :term:`IMU` sensor that can be used for measuring headings and accelerations. Using it is as simple as writing a robot program, and running it on your computer. It will command the Romi to follow the steps in the program. +The Romi is a small and inexpensive robot designed for learning about programming FRC\ |reg| robots. All the same tools used for programming full-sized FRC robots can be used to program the Romi. The Romi comes with two drive motors with integrated wheel encoders. It also includes an :term:`IMU` sensor that can be used for measuring headings and accelerations. Using it is as simple as writing a robot program, and running it on your computer. It will command the Romi to follow the steps in the program. -.. tip:: A course that teaches programming using the Romi Robot is available via Thinkscape. Information on this course is available [here](https://www.firstinspires.org/robotics/frc/blog/2021-skill-building-update-intro-to-programming-module) +.. tip:: A course that teaches programming using the Romi Robot is available via [FIRST Training](https://training.firstinspires.org/catalog?labels=%5B%22Topics%22%5D&values=%5B%22Programming%22%5D). [Part 1](https://training.firstinspires.org/courses/java-programming-part-1) takes users through setup of the hardware and software, methods, objects, conditionals, variables, and equations. [Part 2](https://training.firstinspires.org/courses/java-programming-part-2) covers command based programming, driving and inputs, advanced conditionals and logical operators, command groups, arrays and loops, and errors and troubleshooting. .. image:: images/romi.png :alt: Romi Robot diff --git a/source/docs/software/dashboards/advantagescope.rst b/source/docs/software/dashboards/advantagescope.rst index 99a37462e9..d3cd79fb1e 100644 --- a/source/docs/software/dashboards/advantagescope.rst +++ b/source/docs/software/dashboards/advantagescope.rst @@ -10,7 +10,7 @@ The capabilities of AdvantageScope include: - Display of numeric, textual, and boolean data in graphs and tables - Visualization of pose and mechanism data in 2D and 3D, including custom 3D robot models -- Automatic synchronization of data sources, including log files, match videos, and [Zebra MotionWorks](https://www.firstinspires.org/robotics/frc/blog/2023-zebra-motionworks-for-first-robotics-competition-at-the-first-championship) tracking +- Automatic synchronization of data sources, including various types of log files and match videos - Specialized displays for joysticks, swerve module states, and console text - Analysis of numeric fields using histograms and statistical measures - Multiple export options, including CSV, and WPILib data logs diff --git a/source/docs/software/hardware-apis/pneumatics/pressure.rst b/source/docs/software/hardware-apis/pneumatics/pressure.rst index 4f35cbb294..30e40fb822 100644 --- a/source/docs/software/hardware-apis/pneumatics/pressure.rst +++ b/source/docs/software/hardware-apis/pneumatics/pressure.rst @@ -13,16 +13,17 @@ Construct a ``Compressor`` object: .. tab-item:: Java :sync: Java - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java :language: java :lines: 39-40 .. tab-item:: C++ (Header) :sync: C++ (Header) - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/Solenoid/include/Robot.h + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibcExamples/src/main/cpp/examples/Solenoid/include/Robot.h :language: c++ :lines: 54-55 + .. tab-item:: CTRE Pneumatics Control Module (PCM) .. tab-set:: @@ -55,7 +56,7 @@ Querying compressor current and state: .. tab-item:: C++ (Source) :sync: C++ (Source) - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/Solenoid/cpp/Robot.cpp + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibcExamples/src/main/cpp/examples/Solenoid/cpp/Robot.cpp :language: c++ :lines: 26-28, 31-32, 35-37 @@ -119,14 +120,14 @@ The Pneumatic Hub has analog inputs that may be used to read a pressure transduc .. tab-item:: C++ (Header) :sync: C++ (Header) - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/Solenoid/include/Robot.h + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibcExamples/src/main/cpp/examples/Solenoid/include/Robot.h :language: c++ :lines: 54-55 .. tab-item:: C++ (Source) :sync: C++ (Source) - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/Solenoid/cpp/Robot.cpp + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibcExamples/src/main/cpp/examples/Solenoid/cpp/Robot.cpp :language: c++ :lines: 19-23 @@ -139,12 +140,12 @@ A pressure transducer can be connected to the Analog Input ports on the roboRIO, .. tab-item:: Java :sync: Java - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/rapidreactcommandbot/subsystems/Pneumatics.java + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/rapidreactcommandbot/subsystems/Pneumatics.java :language: java - :lines: 16-24 - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/rapidreactcommandbot/subsystems/Pneumatics.java + :lines: 17-25 + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/rapidreactcommandbot/subsystems/Pneumatics.java :language: java - :lines: 40-41 + :lines: 36-37 .. tab-item:: C++ (Header) :sync: C++ (Header) diff --git a/source/docs/software/hardware-apis/pneumatics/solenoids.rst b/source/docs/software/hardware-apis/pneumatics/solenoids.rst index 737f2dbed6..45f6c7ce0d 100644 --- a/source/docs/software/hardware-apis/pneumatics/solenoids.rst +++ b/source/docs/software/hardware-apis/pneumatics/solenoids.rst @@ -15,19 +15,19 @@ Single solenoids in WPILib are controlled using the ``Solenoid`` class ([Java](h .. tab-item:: Java :sync: Java - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java :language: java :lines: 30-32 :lineno-match: - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-3/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java :language: java - :lines: 88-93 + :lines: 72-77 :lineno-match: .. tab-item:: C++ (Header) :sync: C++ (Header) - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/Solenoid/include/Robot.h + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibcExamples/src/main/cpp/examples/Solenoid/include/Robot.h :language: c++ :lines: 44-47 :lineno-match: @@ -35,7 +35,7 @@ Single solenoids in WPILib are controlled using the ``Solenoid`` class ([Java](h .. tab-item:: C++ (Source) :sync: C++ (Source) - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/Solenoid/cpp/Robot.cpp + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibcExamples/src/main/cpp/examples/Solenoid/cpp/Robot.cpp :language: c++ :lines: 42-47 :lineno-match: @@ -50,20 +50,20 @@ Double solenoids are controlled by the ``DoubleSolenoid`` class in WPILib ([Java .. tab-item:: Java :sync: Java - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java :language: java :lines: 34-37 :lineno-match: - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-3/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/examples/solenoid/Robot.java :language: java - :lines: 100, 102 + :lines: 84, 86 :linenos: - :lineno-start: 100 + :lineno-start: 84 .. tab-item:: C++ (Header) :sync: C++ (Header) - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/Solenoid/include/Robot.h + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibcExamples/src/main/cpp/examples/Solenoid/include/Robot.h :language: c++ :lines: 49-52 :lineno-match: @@ -71,7 +71,7 @@ Double solenoids are controlled by the ``DoubleSolenoid`` class in WPILib ([Java .. tab-item:: C++ (Source) :sync: C++ (Source) - .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2024.1.1-beta-4/wpilibcExamples/src/main/cpp/examples/Solenoid/cpp/Robot.cpp + .. rli:: https://raw.githubusercontent.com/wpilibsuite/allwpilib/v2025.3.2/wpilibcExamples/src/main/cpp/examples/Solenoid/cpp/Robot.cpp :language: c++ :lines: 54, 56 :linenos: diff --git a/source/docs/software/support/support-resources.rst b/source/docs/software/support/support-resources.rst index 0cddbeccf6..bf97f0d2a9 100644 --- a/source/docs/software/support/support-resources.rst +++ b/source/docs/software/support/support-resources.rst @@ -9,7 +9,7 @@ In addition to the documentation here, there are a variety of other resources av In addition to this site there are a few other places teams may check for documentation: - [NI FRC Community Documents Section](https://forums.ni.com/t5/FIRST-Robotics-Competition/bd-p/1014?profile.language=en&view=documents) -- [FIRST Inspires Technical Resources Page](https://www.firstinspires.org/resource-library/frc/technical-resources) +- [FIRST Inspires Technical Resources Page](https://www.firstinspires.org/resources/library/frc/technical-resources) - [CTRE Software & Resources Page](https://store.ctr-electronics.com/software/) - [REV Robotics Documentation](https://docs.revrobotics.com/docs/) - [Vivid Hosting](https://frc-radio.vivid-hosting.net/)