Skip to content

Commit 9b3f625

Browse files
authored
Merge branch 'main' into contrib-update
2 parents 9fc8213 + 47f9c8b commit 9b3f625

File tree

29 files changed

+115
-83
lines changed

29 files changed

+115
-83
lines changed

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ python-git-info==0.8.3
1111
sphinxcontrib-mermaid==0.9.2
1212
sphinx-hoverxref==1.3.0
1313
sphinxext-rediraffe==0.2.7
14-
git+https://github.com/FIRST-Tech-Challenge/ftcdocs-helper@main#subdirectory=linkcheckdiff
14+
sphinx-notfound-page==1.1.0
15+
git+https://github.com/FIRST-Tech-Challenge/ftcdocs-helper@main#subdirectory=linkcheckdiff

docs/source/404.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. meta::
2+
:title: Page not found
3+
:description: The official home of FIRST Tech Challenge Documentation.
4+
:orphan:
5+
6+
Page not found
7+
==============
8+
9+
Unfortunately we couldn't find the content you were looking for. Try using the sidebar menu links or search box.
10+
11+
TensorFlow and the *FIRST* Machine Learning Toolchain content has been moved to the `FTC Docs Archive <https://ftc-docs.firstinspires.org/projects/ftcdocs-archive/en/latest/index.html>`__.
12+
13+

docs/source/_templates/layout.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<div class="link-bar-container">
1414
<div id="link-bar" class="collapse">
1515
<ul>
16-
<li id="ftc-page-link"><a href="https://www.firstinspires.org/resource-library/ftc/game-and-season-info" target="_blank"><i>FIRST</i> Official Team Resources</a></li>
16+
<li id="ftc-page-link"><a href="https://ftc-resources.firstinspires.org/ftc/game" target="_blank"><i>FIRST</i> Official Team Resources</a></li>
1717
<li id="qa-link"><a href="https://ftc-qa.firstinspires.org/" target="_blank">Official Game Q&A</a></li>
1818
</ul>
1919
</div>

docs/source/apriltag/vision_portal/apriltag_intro/apriltag-intro.rst

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ several resources:
2525
image processing library
2626
- myBlocks: custom Blocks created in OnBot Java (OBJ)
2727

28-
Now these three areas are provided, or bundled, in the new *FIRST* **Tech Challenge
29-
Software Development Kit (SDK), version 8.2**.
28+
Now these three areas are provided, or bundled, in the *FIRST* **Tech Challenge
29+
Software Development Kit (SDK), starting with version 8.2**.
3030

3131
Namely, key capabilities of **AprilTag** and **EasyOpenCV** are
3232
available to the Robot Controller (RC) and Driver Station (DS) apps,
3333
without special downloads. And AprilTag features are included in **FTC
3434
Blocks**, without needing custom myBlocks.
3535

36-
The AprilTag features work on Android RC phone cameras, and on webcams.
37-
A single OpMode can use AprilTag and TensorFlow Object Detection (TFOD).
36+
The AprilTag features work on webcams and on Android RC phone cameras.
37+
A single OpMode can use AprilTag and Color Processing.
3838

3939
In *FIRST* Tech Challenge, AprilTag is ready for the spotlight!
4040

@@ -66,7 +66,7 @@ containing information and designed for easy recognition.
6666
The above samples represent different formats, or **families**. A
6767
project typically uses a single AprilTag family.
6868

69-
This year, *FIRST* Tech Challenge uses a common family called **36h11**. A PDF
69+
*FIRST* Tech Challenge uses a common family called **36h11**. A PDF
7070
showing the numbers 0 through 20 from the 36h11 family can be downloaded here:
7171

7272
- :download:`AprilTag PDF 0-20 <files/AprilTag_0-20_family36h11.pdf>`
@@ -175,17 +175,17 @@ remains within the camera’s field of view. Namely, an OpMode “**while() loop
175175
should regularly read the updated pose data, to guide the robot’s driving
176176
actions.
177177

178-
The new SDK supports **multiple cameras**, switchable or simultaneous. This
178+
The SDK supports **multiple cameras**, switchable or simultaneous. This
179179
can help if the robot changes direction, or you wish to navigate using another
180-
AprilTag (or TensorFlow object).
180+
AprilTag (or Color Processing).
181181

182182
Other sensors can also be used for navigation, such as drive motor encoders,
183183
REV Hub IMU, deadwheel encoders, color/distance sensors, ultrasonic sensors,
184184
and more.
185185

186186
It’s also possible to evaluate **non-AprilTag images** from the same camera
187187
and/or a second camera. For example, the SDK can estimate the horizontal angle
188-
(or Bearing) of an object detected with **TensorFlow**, another vision
188+
(or Bearing) of an object detected with **Color Processing**, another vision
189189
technology employed in *FIRST* Tech Challenge. Advanced teams might consider
190190
active camera pointing control, to keep an AprilTag or other object in view.
191191

@@ -215,7 +215,7 @@ tags are **not** annotated by default with a colored border.
215215

216216
Note: **Camera Stream** displays a snapshot of the camera’s view, on the Driver
217217
Station device. It’s available only during the INIT phase of an OpMode, and
218-
also shows any AprilTag (or TFOD) annotations. Instructions are posted here:
218+
also shows any AprilTag (or Color Processing) annotations. Instructions are posted here:
219219

220220
- :ref:`Camera Stream Image Preview Documentation <hardware_and_software_configuration/configuring/configuring_external_webcam/configuring-external-webcam:image preview>`
221221

@@ -301,12 +301,12 @@ pose data in real-time to navigate to the desired location on the field.
301301
Vision processing can consume significant **CPU resources** and USB
302302
communications **bandwidth**. *FIRST* Tech Challenge teams may balance the
303303
benefits of higher resolution and speed (frames-per-second) against the risk of
304-
overloading CPU and bandwidth resources. The 8.2 SDK provides numerous tools to
304+
overloading CPU and bandwidth resources. The SDK 8.2 or later provides numerous tools to
305305
manage this balance:
306306

307307
- select the camera resolution
308308
- disable and enable the RC preview (called LiveView)
309-
- disable and enable the AprilTag (or TFOD) processor
309+
- disable and enable the AprilTag (or Color Processing) processor
310310
- close the camera stream
311311
- select a compressed video streaming format
312312
- measure frames-per-second
@@ -315,18 +315,18 @@ manage this balance:
315315

316316
**Option 3**
317317

318-
Clearer camera images can improve AprilTag (and TFOD) vision processing.
318+
Clearer camera images can improve AprilTag (and Color Processing) vision processing.
319319
The SDK offers powerful **webcam controls** (Exposure, Gain, Focus,
320-
and more), now available in FTC Blocks! These controls can be applied
320+
and more), also available in FTC Blocks! These controls can be applied
321321
under various lighting conditions.
322322

323-
Exposure and Gain are adjusted together. The new SDK offers Java Sample
323+
Exposure and Gain are adjusted together. The SDK offers Java Sample
324324
OpMode ``ConceptAprilTagOptimizeExposure.java``.
325325

326326
**Option 4**
327327

328328
The frame of reference described above in **AprilTag Axes** is
329-
calculated and provided by default in the new 8.2 SDK. Advanced teams
329+
calculated and provided by default in the 8.2 SDK or later. Advanced teams
330330
may prefer to perform their own pose calculations, based on **raw
331331
values** from the AprilTag/EasyOpenCV pipeline.
332332

@@ -381,7 +381,7 @@ Summary
381381
AprilTag is a popular camera-based technology, using a scanned image
382382
similar to a QR Code.
383383

384-
The new SDK version 8.2 now includes key capabilities of AprilTag and
384+
The SDK version 8.2 or later includes key capabilities of AprilTag and
385385
EasyOpenCV, a *FIRST* Tech Challenge-optimized interface with OpenCV for image
386386
processing. These methods are packaged for convenient use by **Java and Blocks
387387
programmers**.
@@ -399,8 +399,8 @@ Each camera requires **calibration data**, for a specific resolution, to
399399
provide good pose estimates.
400400

401401
Multiple cameras are supported, and a single OpMode can use AprilTag and
402-
TensorFlow Object Detection (TFOD). AprilTag detection is improved with
403-
webcam Camera Controls, now available also in FTC Blocks.
402+
Color Processing. AprilTag detection is improved with
403+
webcam Camera Controls, available also in FTC Blocks.
404404

405405
**In** *FIRST* **Tech Challenge, AprilTag is ready to take CENTERSTAGE!**
406406

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
'sphinxcontrib.mermaid',
3232
'hoverxref.extension',
3333
"sphinxext.rediraffe",
34+
'notfound.extension',
3435
"ftcdocs_linkcheckdiff",
3536
]
3637

docs/source/contrib/style_guide/style-guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -327,17 +327,17 @@ External Links
327327
^^^^^^^^^^^^^^
328328

329329
Links to other websites and even to the main *FIRST* Inspires site are call *external links*.
330-
It's possible to create a link by entering the URL in the text https://www.firstinspires.org/resource-library/ftc/game-and-season-info.
330+
It's possible to create a link by entering the URL in the text https://ftc-resources.firstinspires.org/ftc/game.
331331
Sphinx will build a link when it encounters a URL. But that is not the preferred approach.
332332

333333
Use descriptive link text rather than just embedding a URL.
334334
Use the following RST syntax:
335335

336336
.. code:: rest
337337
338-
`Game and Season Materials <https://www.firstinspires.org/resource-library/ftc/game-and-season-info>`_
338+
`Game and Season Materials <https://ftc-resources.firstinspires.org/ftc/game>`_
339339
340-
Which looks like: `Game and Season Materials <https://www.firstinspires.org/resource-library/ftc/game-and-season-info>`_
340+
Which looks like: `Game and Season Materials <https://ftc-resources.firstinspires.org/ftc/game>`_
341341

342342
FTC Docs has chosen to open links to external sites in new tabs. This is done with JavaScript.
343343
We mitigate this somewhat by adding an icon that indicates the link is to an external site and add screen reader only text.

docs/source/game_specific_resources/blog/blog.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The `FIRST Community Blog <https://community.firstinspires.org/>`__ hosts the b
66
*FIRST* Tech Challenge program specific information can be found on the
77
`FIRST Tech Challenge Blog <https://community.firstinspires.org/topic/ftc>`__. The blog hosts articles
88
that go beyond what can be covered in the
9-
`Team Email Blasts <https://www.firstinspires.org/resource-library/ftc/team-blast-archive>`__ .
9+
`Team Email Blasts <https://www.firstinspires.org/resources/library/ftc/team-email-blast-archive>`__ .
1010

1111
.. only:: html
1212

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ and :doc:`gracious_professionalism/gp` to see why.
112112
faq/faqs
113113
Team Complimentary Software<sponsors/software/software>
114114
Team Discounts<sponsors/discounts/discounts>
115+
team_resources/team_resources
115116

116117
.. toctree::
117118
:caption: FTC Docs

docs/source/persona_pages/rookie_teams/rookie_teams.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ resource you want to explore!
4040

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

43-
.. button-link:: https://www.firstinspires.org/node/20896
43+
.. button-link:: https://help.firstinspires.org/s/article/What-is-Coopertition
4444
:ref-type: doc
4545
:color: black
4646
:outline:
@@ -52,7 +52,7 @@ resource you want to explore!
5252

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

55-
.. button-link:: https://www.firstinspires.org/robotics/fll/core-values
55+
.. button-link:: https://help.firstinspires.org/s/article/What-are-the-FIRST-Core-Values
5656
:ref-type: doc
5757
:color: black
5858
:outline:
@@ -160,12 +160,12 @@ resource you want to explore!
160160

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

163-
.. button-link:: https://www.firstinspires.org/node/5181
163+
.. button-link:: https://ftc-resources.firstinspires.org/ftc/team
164164
:color: black
165165
:outline:
166166
:expand:
167167

168-
Robot Building Resources (external)
168+
Team Resources (external)
169169

170170
.. grid-item-card::
171171
:class-header: sd-bg-secondary font-weight-bold sd-text-black
@@ -227,7 +227,7 @@ resource you want to explore!
227227

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

230-
.. button-link:: https://www.firstinspires.org/node/5226
230+
.. button-link:: https://www.firstinspires.org/resources/library/ftc/team-management-resources
231231
:ref-type: doc
232232
:color: black
233233
:outline:

docs/source/persona_pages/veteran_teams/veteran_teams.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ resource you want to explore!
105105

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

108-
.. button-link:: https://www.firstinspires.org/node/5226
108+
.. button-link:: https://www.firstinspires.org/resources/library/ftc/team-management-resources
109109
:ref-type: doc
110110
:color: black
111111
:outline:

0 commit comments

Comments
 (0)