Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Replace game manuals 1 & 2 with the new Competition Manual #295

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Replace game manuals 1 & 2 with the new Competition Manual #295

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
9591fec
Replaced the game manuals with the new CM to fix link check
miriamsr Aug 2, 2024
a196dba
Updated references to the game manuals to be the Competition Manual
miriamsr Aug 2, 2024
c126063
Merge branch 'main' into manual
miriamsr Aug 3, 2024
27685a9
Renamed the manuals page
miriamsr Aug 3, 2024
39af77f
Merge branch 'main' into manual
miriamsr Aug 3, 2024
e28f251
Fixed the checks
miriamsr Aug 3, 2024
a122059
Merge branch 'main' into manual
miriamsr Aug 7, 2024
12b8de2
Merge branch 'FIRST-Tech-Challenge:main' into manual
miriamsr Sep 2, 2024
61fd458
Merge branch 'main' into manual
texasdiaz Sep 17, 2024
960e015
fixed typo
miriamsr Sep 17, 2024
a77cc2b
Merge branch 'main' into manual
uvidyadharan Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/source/control_hard_compon/ds_components/components/components.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.revrobotics.com/rev-31-1596/>`_
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 <../../../manuals/competition_manual/competition_manual>`. 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 :doc:`Competition Manual <../../../manuals/competition_manual/competition_manual>`.

USB-OTG Adapter / Hubs
----------------------
Expand Down Expand Up @@ -145,7 +145,7 @@ Comercial USB 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<manuals/game_manuals/game_manuals:game manuals>`. A USB
:ref:`Competition Manual <manuals/competition_manual/competition_manual: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.

Expand Down Expand Up @@ -257,7 +257,7 @@ Gamepads

Quadstick FPS

:ref:`Game Manual 1 <manuals/game_manuals/game_manuals:game manuals>` defines
The :ref:`Competition Manual <manuals/competition_manual/competition_manual: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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/control_hard_compon/ds_components/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.thingiverse.com/thing:3386378>`_,
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 <../../manuals/competition_manual/competition_manual>` for more information
on Driver Station Carriers.

.. tab-set::
Expand Down
12 changes: 6 additions & 6 deletions docs/source/control_hard_compon/rc_components/hub/ports/std-ports.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
It is also recommended that you expand your connector prongs periodically. For more information on this
process please watch this `video <https://www.youtube.com/watch?v=UYXTiSeVmB0>`_. 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 ``<RE15>``,
:ref:`Game Manual Part 1 <manuals/game_manuals/game_manuals:game manuals>`. 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 <manuals/competition_manual/competition_manual:competition manual>`. For more information on this port please see
`REV Documentation <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#input-power-specifications>`_.

Motor Ports
Expand Down Expand Up @@ -46,7 +46,7 @@
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
``<RE05>``, :ref:`Game Manual Part 1 <manuals/game_manuals/game_manuals:game manuals>`. For more information on this port
the :ref:`Competition Manual <manuals/competition_manual/competition_manual:competition manual>`. For more information on this port
please see `REV Servo Port Documentation <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#servo-port-specifications>`_.

+5V Power Ports
Expand All @@ -56,8 +56,8 @@
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 <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#id-5v-power-port-specifications>`_ and
:ref:`Game Manual Part 1 <manuals/game_manuals/game_manuals:game manuals>`.
`REV +5V Power Port Documentation <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#id-5v-power-port-specifications>`_ and the
:ref:`Competion Manual <manuals/competition_manual/competition_manual:competition manual>`.

Check failure on line 60 in docs/source/control_hard_compon/rc_components/hub/ports/std-ports.rst

View workflow job for this annotation

GitHub Actions / spelling-check 

[misspell] reported by reviewdog 🐶
"Competion" is a misspelling of "Competition"

Raw Output:
./docs/source/control_hard_compon/rc_components/hub/ports/std-ports.rst:60:6: "Competion" is a misspelling of "Competition"
miriamsr marked this conversation as resolved.
Show resolved Hide resolved

Analog Ports
--------------
Expand Down Expand Up @@ -88,7 +88,7 @@
These 4-pin `JST-PH <https://docs.revrobotics.com/duo-control/control-system-overview/cables-and-connectors/jst-ph-sensors-and-rs485>`_
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 <manuals/game_manuals/game_manuals:game manuals>`. While it is possible to use a large range of
by the :ref:`Competition Manual <manuals/competition_manual/competition_manual: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 <https://docs.revrobotics.com/duo-control/control-system-overview/control-hub-basics#i2c-port-specifications>`_.
Expand Down
6 changes: 3 additions & 3 deletions docs/source/control_hard_compon/rc_components/motors/motors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <manuals/game_manuals/game_manuals:game manuals>`. 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 <manuals/competition_manual/competition_manual:competition manual>`. They may only be controlled
via a REV Expansion Hub, REV Control Hub, REV SPARKmini Motor Controller, or VEX Motor
Controller 29. ``<RE09>``
Controller 29.

Additional Resources
---------------------
Expand Down
22 changes: 10 additions & 12 deletions docs/source/control_hard_compon/rc_components/power_distr/power-distr.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 ``<RE03>`` in the
:ref:`Game Manual Part 1<manuals/game_manuals/game_manuals:game manuals>`
the batteries shown above. Refer to the
:ref:`Competition Manual <manuals/competition_manual/competition_manual:competition manual>`
for exact information on allowed batteries. Note that it is typically allowed
by ``<RE15>`` 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::
Expand Down Expand Up @@ -146,9 +146,9 @@ 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<manuals/game_manuals/game_manuals:game manuals>`.
The legal power switches are shown above. ``<RE01>``
along with its label should be placed in accordance to the
:ref:`Competition Manual <manuals/competition_manual/competition_manual:competition manual>`.
The legal power switches are shown above.

:download:`Power Switch Label <https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/power-button-labels.pdf>`

Expand Down Expand Up @@ -195,7 +195,7 @@ Power Distribution Block

Power Distribution Blocks help to distribute the power to devices such as
Control Hubs, SPARKminis, and more.
See :ref:`Game Manual Part 1<manuals/game_manuals/game_manuals:game manuals>`
See the :ref:`Competition Manual <manuals/competition_manual/competition_manual:competition manual>`
for a description of legal Power Distribution methods. The Power
Distribution Blocks shown are not the only legal devices for power distribution.

Expand Down Expand Up @@ -252,11 +252,9 @@ 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<manuals/game_manuals/game_manuals:game manuals>`. In the 2023-2024
season, these batteries were deemed permissible to power LEDs (per
``<RE12>f.ii``) and, by extension, COTS light controller sources like the `REV
Blinkin <https://www.revrobotics.com/rev-11-1105/>`__ (per ``<RE12>e``).
that can be used in specific situations in accordance with the :ref:`Competition Manual <manuals/competition_manual/competition_manual:competition manual>`. In the 2023-2024
season, these batteries were deemed permissible to power LEDs and, by extension, COTS light controller sources like the `REV
Blinkin <https://www.revrobotics.com/rev-11-1105/>`_.
However, having a COTS USB External Battery on the Robot carries additional
considerations. All teams must ensure their COTS USB Battery Pack:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/control_hard_compon/rc_components/sensors/sensors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Sensors
=========

.. note::
As per :ref:`Game Manual Part 1<manuals/game_manuals/game_manuals:game manuals>`
As per the :ref:`Competition Manual <manuals/competition_manual/competition_manual:competition manual>`
a UVC Webcam is not considered a sensor.

Listed below are some examples of common robot sensors. This is not
Expand Down
18 changes: 10 additions & 8 deletions ...rce/game_specific_resources/playing_field_resources/playing_field_resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,25 @@ 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 Competition Area 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 Competition Area 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 :ref:`Game Manual Part 2<manuals/game_manuals/game_manuals:game manuals>`.
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 <manuals/competition_manual/competition_manual:competition manual>`.


Traditional Field Setup Guide
------------------------------------

This document can be found here: `Traditional Field Setup Guide <https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/field-assembly-and-setup-guide.pdf>`__
Check back after kickoff for the INTO THE DEEP Field Setup Guide.

.. only:: html
.. comment

.. raw:: html
.. only:: html

.. raw:: html

<iframe id="iframepdf" src="https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/field-assembly-and-setup-guide.pdf" width="100%" height="700"></iframe>
<iframe id="iframepdf" src="https://firstinspiresst01.blob.core.windows.net/first-in-show-ftc/field-assembly-and-setup-guide.pdf" width="100%" height="700"></iframe>

|
|

Remote Field Setup Guide
------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ to see why.

game_specific_resources/blog/blog
tech_tips/tech-tips
manuals/game_manuals/game_manuals
manuals/competition_manual/competition_manual
Game Q&A Forum <game_specific_resources/ftcqa/ftcqa>
game_specific_resources/playing_field_resources/playing_field_resources
Field Coordinate System <game_specific_resources/field_coordinate_system/field-coordinate-system>
Expand Down Expand Up @@ -378,13 +378,13 @@ to see why.

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

.. button-ref:: manuals/game_manuals/game_manuals
.. button-ref:: manuals/competition_manual/competition_manual
:ref-type: doc
:color: black
:outline:
:expand:

Game Manuals
Competition Manual

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

Expand Down
15 changes: 15 additions & 0 deletions docs/source/manuals/competition_manual/competition_manual.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Competition Manual
==================

The Competition Manual can be found on the `Game and Season Materials page <https://www.firstinspires.org/resource-library/ftc/game-and-season-info>`__ on the *FIRST* Website. It is also here for your convenience.

`2024-2025 INTO THE DEEP Competition Manual <https://firstinspires.blob.core.windows.net/ftc/2024-25/Competition-Manual.pdf>`__

.. only:: html

.. raw:: html

<iframe id="iframepdf" src="https://firstinspires.blob.core.windows.net/ftc/2024-25/Competition-Manual.pdf" width="100%" height="700"></iframe>

|

61 changes: 0 additions & 61 deletions docs/source/manuals/game_manuals/game_manuals.rst
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions docs/source/persona_pages/rookie_teams/rookie_teams.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,13 +109,13 @@ resource you want to explore!

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

.. button-ref:: ../../manuals/game_manuals/game_manuals
.. button-ref:: ../../manuals/competition_manual/competition_manual
:ref-type: doc
:color: black
:outline:
:expand:

Game Manuals
Competition Manual

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

Expand Down
4 changes: 1 addition & 3 deletions docs/source/programming_resources/shared/installing_kotlin/Installing-Kotlin.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 **<RS02>**
"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.

Expand Down
1 change: 1 addition & 0 deletions docs/source/redirects.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"manuals/game_manuals/game_manuals.rst" "manuals/competition_manual/competition_manual.rst"
Loading