diff --git a/docs/source/control_hard_compon/ds_components/components/components.rst b/docs/source/control_hard_compon/ds_components/components/components.rst index 92f9508a..6f4df52f 100644 --- a/docs/source/control_hard_compon/ds_components/components/components.rst +++ b/docs/source/control_hard_compon/ds_components/components/components.rst @@ -45,11 +45,11 @@ The heart of the Driver Station is the Android Device that runs the Driver Station App. This Android Device requirement can be fulfilled either through the use of a `REV Driver Hub `_ -or one of the approved Android Smartphones listed in -:doc:`Game Manual 1 <../../../manuals/game_manuals/game_manuals>`. It is of +or one of the approved Android Smartphones listed in the +:doc:`Competition Manual <../../../team_resources/team_resources>`. It is of vital importance that the Driver Station App be updated to a version that meets or exceeds the minimum Driver Station App version as -defined in :doc:`Game Manual 1 <../../../manuals/game_manuals/game_manuals>`. +defined in the Competition Manual. USB-OTG Adapter / Hubs ---------------------- @@ -144,8 +144,7 @@ Comercial USB Battery Pack Anker Battery Pack A commercial USB battery pack is an auxiliary power source that can be used in -specific situations in accordance with the -:ref:`Game Manuals`. A USB +specific situations in accordance with the Competition Manual. A USB battery pack is permitted to be used to charge your Android Device. Only the REV Driver Hub can be charged while in use, through its USB-C port. @@ -257,7 +256,7 @@ Gamepads Quadstick FPS -:ref:`Game Manual 1 ` defines +The Competition Manual defines the gamepads that are allowed in competition play. Up to two gamepads, in any combination, of the allowed types of gamepads may be used. All gamepads MUST be used in wired mode only, no wireless of any kind is allowed. Special features of diff --git a/docs/source/control_hard_compon/ds_components/index.rst b/docs/source/control_hard_compon/ds_components/index.rst index 14a591b2..79b181c4 100644 --- a/docs/source/control_hard_compon/ds_components/index.rst +++ b/docs/source/control_hard_compon/ds_components/index.rst @@ -14,8 +14,8 @@ way represent the only possible way of connecting these components. These images also do not represent using a `Driver Station Carrier `_, which is recommended for teams to use for component management and -transportation. See rule ``DS07`` in -:doc:`Game Manual 1 <../../manuals/game_manuals/game_manuals>` for more information +transportation. See the +:doc:`Competition Manual <../../team_resources/team_resources>` for more information on Driver Station Carriers. .. tab-set:: diff --git a/docs/source/control_hard_compon/rc_components/hub/ports/std-ports.rst b/docs/source/control_hard_compon/rc_components/hub/ports/std-ports.rst index 65c4c97a..f6f7019b 100644 --- a/docs/source/control_hard_compon/rc_components/hub/ports/std-ports.rst +++ b/docs/source/control_hard_compon/rc_components/hub/ports/std-ports.rst @@ -11,8 +11,8 @@ As the connector is known for its fragility it is highly recommended you be care It is also recommended that you expand your connector prongs periodically. For more information on this process please watch this `video `_. While this video features an XT60, a larger version of the XT-30, and a drone the advice is much the same. This port may also be used -to connect a grounding strap. For more information on legal grounding straps see ````, -:ref:`Game Manual Part 1 `. For more information on this port please see +to connect a grounding strap. For more information on legal grounding straps see the, +:ref:`Competition Manual `. For more information on this port please see `REV Documentation `_. Motor Ports @@ -46,7 +46,7 @@ Servo Ports These 0.1” Header pins are used to power and control your servos. There are 6 ports on each hub and they are numbered from 0-5. Be mindful of matching the polarity of the device attached to this port as it is possible to flip the connector. For increasing the power supplied to these servos it is possible to use a Servo Power Module that is in compliance with -````, :ref:`Game Manual Part 1 `. For more information on this port +the Competition Manual. For more information on this port please see `REV Servo Port Documentation `_. +5V Power Ports @@ -56,8 +56,8 @@ These 0.1” Header pins are used to power and control various appliances. There are two ports on each hub. These connectors can be used for a limited range of applications in FIRST Tech Challenge, such as powering powered USB hubs. For more information on this port please see -`REV +5V Power Port Documentation `_ and -:ref:`Game Manual Part 1 `. +`REV +5V Power Port Documentation `_ and the +Competition manual. Analog Ports -------------- @@ -88,7 +88,7 @@ I2C Ports These 4-pin `JST-PH `_ style connectors are used for connecting I2C sensors. Each port is a single I2C bus where multiple sensors can be attached. Using sensors with identical addresses on the same bus can cause problems. The range of I2C sensors that can be connected is limited -by :ref:`Game Manual Part 1 `. While it is possible to use a large range of +by the Competition Manual. While it is possible to use a large range of sensors, the vast majority of I2C sensors do not have drivers built into the SDK. It is possible to use community drivers or create your own. For more information on this port please see `REV I2C Port Documentation `_. diff --git a/docs/source/control_hard_compon/rc_components/motors/motors.rst b/docs/source/control_hard_compon/rc_components/motors/motors.rst index 0684531d..f5e9d056 100644 --- a/docs/source/control_hard_compon/rc_components/motors/motors.rst +++ b/docs/source/control_hard_compon/rc_components/motors/motors.rst @@ -89,10 +89,10 @@ Motors REV Robotics Core Hex 12V DC Motor -Motors are the primary drivers of a robot. All motors are 12v brushed DC motors and are enumerated in -:ref:`Game Manual Part 1 `. They may only be controlled +Motors are the primary drivers of a robot. All motors are 12v brushed DC motors and are enumerated in the +:ref:`Competition Manual `. They may only be controlled via a REV Expansion Hub, REV Control Hub, REV SPARKmini Motor Controller, or VEX Motor -Controller 29. ```` +Controller 29. Additional Resources --------------------- diff --git a/docs/source/control_hard_compon/rc_components/power_distr/power-distr.rst b/docs/source/control_hard_compon/rc_components/power_distr/power-distr.rst index f9274d0e..186eafca 100644 --- a/docs/source/control_hard_compon/rc_components/power_distr/power-distr.rst +++ b/docs/source/control_hard_compon/rc_components/power_distr/power-distr.rst @@ -59,10 +59,10 @@ Robot Main Battery REV Robotics (REV-31-1302) The main power of a robot comes from one 12v battery. The battery may be one of -the batteries shown above. Refer to section ```` in the -:ref:`Game Manual Part 1` +the batteries shown above. Refer to the +:ref:`Competition Manual ` for exact information on allowed batteries. Note that it is typically allowed -by ```` to replace the connector on the batteries, provided the in-line +to replace the connector on the batteries, provided the in-line fuse on the battery is preserved. .. warning:: @@ -146,9 +146,8 @@ Main Power Switch One Main Power Switch must control all power provided by the Main Battery. It -along with its label should be placed in accordance to -:ref:`Game Manual Part 1`. -The legal power switches are shown above. ```` +along with its label should be placed in accordance to the Competition manual. +The legal power switches are shown above. :download:`Power Switch Label ` @@ -194,8 +193,7 @@ Power Distribution Block goBILDA (SKU: 3108-2833-0801) Power Distribution Blocks help to distribute the power to devices such as -Control Hubs, SPARKminis, and more. -See :ref:`Game Manual Part 1` +Control Hubs, SPARKminis, and more. See the Competition Manual for a description of legal Power Distribution methods. The Power Distribution Blocks shown are not the only legal devices for power distribution. @@ -252,11 +250,7 @@ COTS USB Battery Pack Anker Battery Pack A Commercial Off The Shelf (COTS) USB battery pack is an auxiliary power source -that can be used in specific situations in accordance with the :ref:`Game -Manuals`. In the 2023-2024 -season, these batteries were deemed permissible to power LEDs (per -``f.ii``) and, by extension, COTS light controller sources like the `REV -Blinkin `__ (per ``e``). +that can be used in specific situations in accordance with the Competition Manual. However, having a COTS USB External Battery on the Robot carries additional considerations. All teams must ensure their COTS USB Battery Pack: diff --git a/docs/source/control_hard_compon/rc_components/sensors/sensors.rst b/docs/source/control_hard_compon/rc_components/sensors/sensors.rst index 6ad2ef22..c5239341 100644 --- a/docs/source/control_hard_compon/rc_components/sensors/sensors.rst +++ b/docs/source/control_hard_compon/rc_components/sensors/sensors.rst @@ -2,7 +2,7 @@ Sensors ========= .. note:: - As per :ref:`Game Manual Part 1` + As per the :ref:`Competition Manual ` a UVC Webcam is not considered a sensor. Listed below are some examples of common robot sensors. This is not diff --git a/docs/source/game_specific_resources/playing_field_resources/playing_field_resources.rst b/docs/source/game_specific_resources/playing_field_resources/playing_field_resources.rst index f4509c77..757b0d89 100644 --- a/docs/source/game_specific_resources/playing_field_resources/playing_field_resources.rst +++ b/docs/source/game_specific_resources/playing_field_resources/playing_field_resources.rst @@ -8,6 +8,9 @@ Playing Field Resources About the Playing Field ----------------------- +There are multiple configurations of the playing field that can be used. For traditional games, the playing field is a part of the ARENA that includes the 12 ft. x 12 ft. (3.66 m x 3.66 m) field and all +the elements described in the official field drawings. For remote games, the playing field is a part of the ARENA that includes the 12 ft. x 8 ft. (3.66 m x 2.44 m) field and all the elements described +in the official field drawings. The base field stays the same for all games but the game elements are subject to change as per the :ref:`Competition Manual `. There are multiple configurations of the playing field that can be used. For traditional games, the playing field is a part of the Arena that includes the 12 ft. x 12 ft. (3.66 m x 3.66 m) field and all the elements described in the official field drawings. For remote games, the playing field is a part of the Arena that includes a 12 ft. x 8 ft. (3.66 m x 2.44 m) field and all the elements described diff --git a/docs/source/index.rst b/docs/source/index.rst index 94fc5cd2..9490cd7a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -39,7 +39,7 @@ and :doc:`gracious_professionalism/gp` to see why. game_specific_resources/blog/blog tech_tips/tech-tips ai/innovation_corner/innovation-corner - Competition Manual + Team Resources Game Q&A System game_specific_resources/playing_field_resources/playing_field_resources Field Coordinate System @@ -327,13 +327,13 @@ The main menu contains links to the top level content. The following are quick l .. div:: col-sm pl-1 pr-1 - .. button-ref:: manuals/game_manuals/game_manuals + .. button-ref:: team_resources/team_resources :ref-type: doc :color: black :outline: :expand: - Competition Manual + All Team Resources .. div:: col-sm pl-1 pr-1 diff --git a/docs/source/manuals/game_manuals/game_manuals.rst b/docs/source/manuals/game_manuals/game_manuals.rst deleted file mode 100644 index 1a008b8c..00000000 --- a/docs/source/manuals/game_manuals/game_manuals.rst +++ /dev/null @@ -1,5 +0,0 @@ -Game Manuals -============ - -Game Manuals can be found on the `Game and Season Materials page `__ on the *FIRST* Website. They are presented here for your convenience. - diff --git a/docs/source/persona_pages/rookie_teams/rookie_teams.rst b/docs/source/persona_pages/rookie_teams/rookie_teams.rst index 3f1ab8c2..cc2af691 100644 --- a/docs/source/persona_pages/rookie_teams/rookie_teams.rst +++ b/docs/source/persona_pages/rookie_teams/rookie_teams.rst @@ -184,13 +184,13 @@ resource you want to explore! .. div:: col-sm pl-1 pr-1 - .. button-ref:: ../../manuals/game_manuals/game_manuals + .. button-ref:: ../../team_resources/team_resources :ref-type: doc :color: black :outline: :expand: - Competition Manual + General Team Resources .. div:: col-sm pl-1 pr-1 diff --git a/docs/source/programming_resources/shared/installing_kotlin/Installing-Kotlin.rst b/docs/source/programming_resources/shared/installing_kotlin/Installing-Kotlin.rst index da617173..efb88c63 100644 --- a/docs/source/programming_resources/shared/installing_kotlin/Installing-Kotlin.rst +++ b/docs/source/programming_resources/shared/installing_kotlin/Installing-Kotlin.rst @@ -43,9 +43,7 @@ Using Kotlin in *FIRST* Tech Challenge While there is no rule (as of the writing of this document) prohibiting Kotlin as a programming -option in *FIRST* Tech Challenge, it is not one of the recommended tools as listed in **** -"Recommended Programming Tools" portion of the *FIRST* Tech Challenge -:doc:`Game Manual Part 1 <../../../manuals/game_manuals/game_manuals>`. +option in *FIRST* Tech Challenge, it is not one of the officially recommended or supported tools. Teams that use Kotlin do so at their own risk and should expect that there will not be technical help/support available at events in the case of software issues. diff --git a/docs/source/redirects.txt b/docs/source/redirects.txt index 503cc9b5..67382b05 100644 --- a/docs/source/redirects.txt +++ b/docs/source/redirects.txt @@ -1 +1,2 @@ -ftc_docs/workflow/workflow.rst contrib/workflow/workflow.rst \ No newline at end of file +"manuals/game_manuals/game_manuals.rst" "team_resources/team_resources.rst" +ftc_docs/workflow/workflow.rst contrib/workflow/workflow.rst diff --git a/docs/source/team_resources/team_resources.rst b/docs/source/team_resources/team_resources.rst new file mode 100644 index 00000000..25338f35 --- /dev/null +++ b/docs/source/team_resources/team_resources.rst @@ -0,0 +1,23 @@ +Team Resources +============== + +There are several resources that teams might want to access throughout the *FIRST* Tech Challenge +season. + +Pages and Links +~~~~~~~~~~~~~~~ + +| FTC Blog - https://community.firstinspires.org/topic/ftc +| FTC Q&A - https://ftc-qa.firstinspires.org/ +| FTC Game and Season Info - https://ftc.game +| FTC Events site - https://ftc-events.firstinspires.org +| FTC Technical Support - https://ftc-community.firstinspires.org +| FTC Avatar Submission - https://ftc-scoring.firstinspires.org + +Game Specific Resources +~~~~~~~~~~~~~~~~~~~~~~~ + +| All Resources - https://ftc.game +| FTC Competition Manual - https://ftc-resources.firstinspires.org/file/ftc/game/manual +| FTC Competition Manual (HTML) - https://ftc-resources.firstinspires.org/file/ftc/game/cm-html +| FTC Game One-Page Summary - https://ftc-resources.firstinspires.org/file/ftc/game/game-one-page