Convert legacy Tech Tips to the new per-page format - #429
Merged
texasdiaz merged 6 commits intoAug 17, 2026
Conversation
The Tech Tips landing page held 39 "Legacy" Tech Tips in collapsible dropdowns, each titled by its Team E-mail Blast publication date, alongside two "Updated" Tech Tips that had their own pages. Convert all 39 legacy dropdowns into 18 standalone pages, combining Tech Tips that covered the same subject so a topic reads start to finish in one place (the three-part Wi-Fi Bands and Battery Voltage Sag series, the two Wi-Fi monitoring tips, the two Driver Hub tips, and so on). Drop the "Updated" and "Legacy" framing from the landing page, which is now a set of toctrees grouped by subject. Move dc-motor-curve.* out of the shared tech_tips/images/ folder into a per-page images/ folder next to the page that uses it, per the folder-per-topic pattern. The Competition Manual links directly to the #calculatepower anchor on tech-tips.html. That anchor and #powercalculator are retained on the landing page in a short "Moved Tech Tips" section pointing at the new page, so the existing Competition Manual link keeps resolving. The section can be removed once the manual is updated. The "Driver Hub or Smartphone?" tip carries the corrected smartphone support language from PR FIRST-Tech-Challenge#427 rather than the original "approved device" framing. Resolves FIRST-Tech-Challenge#385
cspell flagged the bare word calculatepower in the RST comment explaining why the Moved Tech Tips section exists. Write the anchor as a URL in angle brackets instead, which the existing <...> entry in cspell.json's ignoreRegExpList already covers, and which reads more usefully anyway. The .. _calculatepower: / .. _powercalculator: label targets themselves were never flagged - the first ignoreRegExpList entry covers those lines.
texasdiaz
self-requested a review
August 17, 2026 18:49
texasdiaz
approved these changes
Aug 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #385.
The Tech Tips landing page held 39 "Legacy" Tech Tips in collapsible dropdowns, each titled by its Team E-mail Blast publication date, alongside two "Updated" Tech Tips that already had their own pages. This converts all 39 into standalone pages, combines Tech Tips that covered the same subject, and drops the "Updated"/"Legacy" framing.
39 → 18 mapping
Reviewing the grouping is the most useful thing to do with this PR — everything else follows from it.
tech-tip-hub-tipstech-tip-driver-hubtech-tip-driver-station-choicetech-tip-gamepad-drifttech-tip-noise-and-statictech-tip-battery-caretech-tip-battery-voltage-sagtech-tip-motor-modestech-tip-using-servostech-tip-motor-servo-powertech-tip-wifi-bandstech-tip-wifi-monitoringtech-tip-updating-softwaretech-tip-protecting-robot-codetech-tip-vision-resourcestech-tip-google-ai-studiotech-tip-competition-preptech-tip-ftc-docs-resourcesThe two existing new-format pages (Annual Maintenance, Practice Timer) are unchanged and now sit in the same grouped toctrees.
A few of these are judgment calls — REV Driver Hub Batteries could plausibly live with the other battery content rather than with the Driver Hub, and Robot Controller Source Code could be its own page rather than a section of the software page. Happy to move either.
The 6/24/2024 Competition Manual link
The issue flags that the Competition Manual links directly to the
#calculatepoweranchor ontech-tips.html, and that the legacy tip needs to stay reachable until that link is updated.tech-tips.rstkeeps a short Moved Tech Tips section that holds both.. _calculatepower:and.. _powercalculator:and points at the new page.tech-tips.html#calculatepowertherefore still resolves — verified against the built HTML, bothidattributes are present. An RST comment in the source explains why the section exists; it can be deleted outright once the Competition Manual link points at the new page.Conflicts with #427
This PR rewrites
docs/source/tech_tips/tech-tips.rst, which open PR #427 also edits, so the two conflict by construction and whoever merges second will need to resolve manually.All three of #427's tech-tips hunks are carried forward into the converted pages, so nothing #427 fixes is reintroduced:
important::admonition on smartphone support boundaries, intech-tip-driver-station-choicetech-tip-wifi-monitoringtech-tip-updating-softwareOther changes worth spot-checking
Content is otherwise carried over as-is, but a handful of small editorial freshenings came with the conversion — worth a look rather than assuming verbatim:
dc-motor-curve.jpg/.pngmoved out of the sharedtech_tips/images/folder into a per-pageimages/folder, per the folder-per-topic pattern in AGENTS.md.danger::admonition immediately below it; the admonition is unchanged.:ref:/:doc:cross-references.monitoring-wireless-environment.rstlinked to "the Wi-Fi Bands series" via a hardcodedtech-tips.htmlURL; now a:ref:to the new Wi-Fi Bands page. (This file is also touched by State the smartphone support boundary and remove approved-device framing #427 — the edit is one link.)Checks run
sphinx-build -b html -n --keep-going— clean; the only warning is an unrelated network 429 fetching the intersphinx inventory.#calculatepowerand#powercalculatorpresent ontech-tips.html, the servo power calculator anddc-motor-curvefigure render on the new page.imagesizechecker— pass.rediraffecheckdiff— pass (no.rstfiles moved or renamed).make latexpdfand cspell were not run locally (no LaTeX toolchain or node in this environment) — leaving those to CI.