Skip to content

Make the Android Studio tutorial a standalone, Driver Hub-first path - #426

Open
miriamsr wants to merge 6 commits into
FIRST-Tech-Challenge:mainfrom
miriamsr:issue-407-android-studio-standalone
Open

Make the Android Studio tutorial a standalone, Driver Hub-first path#426
miriamsr wants to merge 6 commits into
FIRST-Tech-Challenge:mainfrom
miriamsr:issue-407-android-studio-standalone

Conversation

@miriamsr

Copy link
Copy Markdown
Member

Addresses #407.

What changed

All edits are confined to programming_resources/android_studio_java/ — no shared/ page is touched, so the Blocks and OnBot Java tutorials are unaffected. No files were renamed, so no redirects.txt entries are needed.

New page: Before You Start (android_studio_java/before_you_start/before-you-start.rst), now the first entry in the tutorial's toctree. It:

  • states the recommended setup — REV Control Hub as the ROBOT CONTROLLER, REV Driver Hub as the DRIVER STATION — and says explicitly that the Blocks/OnBot Java tutorials are not a prerequisite (issue points 1 and 2);
  • describes the smartphone ROBOT CONTROLLER and smartphone DRIVER STATION setups under an Alternate Setups subsection, and tells readers to follow the Control Hub / Driver Hub instructions on pages that document more than one setup (point 3);
  • collects the hardware configuration and Control System pages a Java team needs into a Documentation You Will Need list (point 4);
  • adds a Before Writing Code checklist as a two-column table — each item paired with the page that covers it: hub wiring, device naming, Driver Hub pairing, robot configuration file, OS/firmware/app updates, Android Studio + FtcRobotController project, version compatibility, and the USB Type C deploy path (point 5).

Landing page — the introduction previously claimed the tutorial covers "configuring, programming, and operating your Control System" while mostly linking out. Rewritten to describe the complete path it now actually provides, name the recommended setup up front, and point at Before You Start.

Section pages — the five section stubs were bare toctrees. Each now has a short lead-in saying what the section covers and, where relevant, which linked content applies only to the alternate smartphone setups. The Enabling Developer Options toctree entry is relabeled "Enabling Developer Options (Smartphone Robot Controller)", since a Control Hub ships with Developer Options enabled.

Incidental fixprogramming_resources/laptops/laptops (Computer Requirements) is not reachable from the Programming Resources index; it is now linked from the install section and from Before You Start, where an Android Studio team will actually look for it.

Not covered here

Issue point 3 is only partly addressed. The smartphone-centric material lives inside shared/ pages: Using-Your-Android-Device is almost entirely smartphone content with a three-line Driver Hub stub, and Configuring-Your-Android-Devices carries a full "Two Android Smartphone Configuration" section. Those pages are also in the Blocks and OnBot Java toctrees, so rebalancing them changes all three tutorials and several :ref: targets. This PR reframes at the Android Studio layer only — ordering, link labels, and lead-in prose. The shared-page rewrite is worth a separate issue and a maintainer decision.

Verification

cd docs && make html SPHINXOPTS="-W --keep-going -n" passes. The only warning is an unrelated network failure fetching the Sphinx intersphinx inventory (HTTP 429). No new images, no renames.

miriamsr added 2 commits July 29, 2026 00:51
Addresses FIRST-Tech-Challenge#407.

- Add a 'Before You Start' page as the first section of the Android Studio
  tutorial. It states the recommended Control Hub + Driver Hub setup, describes
  the smartphone Robot Controller / Driver Station setups as alternates, links
  the hardware configuration and Control System pages a Java team needs, and
  adds a 'Before writing code' checklist with a link for each item.
- Rewrite the tutorial landing page introduction so it describes a complete
  getting-started path rather than assuming the reader arrived from the Blocks
  tutorial, and name the recommended setup up front.
- Add short orienting lead-ins to the Introduction, Configuring your Hardware,
  Installing Android Studio, and Writing an Op Mode section pages, noting which
  linked content applies only to the alternate smartphone setups.
- Label the Enabling Developer Options entry as smartphone Robot Controller
  only, since a Control Hub ships with Developer Options enabled.
- Link the computer requirements page from the install section; it was not
  reachable from Programming Resources.
- Drop the assertion that the Control Hub ships preloaded with the Robot
  Controller app; only the Driver Hub's preloaded DS app is documented.
- Replace the invented Robot Controller / Driver Station version inequality
  with the sourced guidance: both come from the current season's release.
- State the USB Type C deploy path positively instead of asserting that the
  Program & Manage network is not required.
miriamsr and others added 4 commits July 31, 2026 22:58
Replaces the recommended/alternate-setup framing with the support boundary:
the Control Hub and Driver Hub are officially supported, and smartphones are
legal to use in competition but unsupported.

@zachwaffle4 zachwaffle4 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would recommend updating the Android Studio screenshots because the UI has changed significantly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Android Studio guide feels outdated / assumes Blocks tutorial context; needs clearer Driver Hub-first setup path

3 participants