De-emphasizing phones #294
Open
Conversation
This file contains 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
|
This looks good to me. T |
|
@miriamsr will you be able to finish this by next week? |
|
@emcclurg Yes, I will get back to work on this, end of next week should be doable. |
rachmo
reviewed
Dec 21, 2024
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| While not recommended, the Competition Manual does allow select Android | ||
| smartphones to be used as a DRIVER STATION or ROBOT CONTROLLER. See rule |
There was a problem hiding this comment.
Rephrase to not point to a specific rule number. Rule numbers may shift year to year.
| robot. It does all of the thinking for the robot and tells the robot what | ||
| to do. It consists of an Android device running a Robot Controller app. Many | ||
| Teams will also connect a REV Robotics Expansion Hub for additional ports to | ||
| connect motors, servos, and sensors to the ROBOT. |
There was a problem hiding this comment.
I think generally ftc-docs does not use the Oxford comma.
| robot. It does all of the thinking for the robot and tells the robot what | ||
| to do. It consists of an Android device running a Robot Controller app. Many | ||
| Teams will also connect a REV Robotics Expansion Hub for additional ports to | ||
| connect motors, servos, and sensors to the ROBOT. | ||
|
|
||
| A second Android device sits with the team drivers and has one or two | ||
| gamepads connected. This second device is known as the DRIVER STATION. | ||
| The DRIVER STATION is sort of like a remote control that you might use |
There was a problem hiding this comment.
Suggest omitting "sort of", for more consistent language/tone of ftc-docs.
| The REV Robotics Control Hub is an integrated version of the Robot Controller. | ||
| It combines an Android device built into the same case as a REV Robotics | ||
| Expansion Hub. | ||
| While not reccomended, teams may opt to use an Android smartphone as either their |
There was a problem hiding this comment.
"recommended" is misspelled, but anyway I suggest omitting that opening phrase. The actual status of smartphones is that they are optional, covered by "Teams may opt to...". Some teams have a legitimate need or preference for smartphones.
| It combines an Android device built into the same case as a REV Robotics | ||
| Expansion Hub. | ||
| While not reccomended, teams may opt to use an Android smartphone as either their | ||
| DRIVER STATION or ROBOT CONTROLLER. DRIVER STATION phones should have the FTC Driver |
There was a problem hiding this comment.
Suggest changing "either...or" to just "or". As an alternate, add ", or both" after ROBOT CONTROLLER.
| @@ -109,14 +107,14 @@ floor and then score a game element (such as a ball) into a goal | |||
| autonomously during a match. Teams write “op modes” (which stand for | |||
| @@ -109,14 +107,14 @@ floor and then score a game element (such as a ball) into a goal | |||
| autonomously during a match. Teams write “op modes” (which stand for | |||
| “operational modes”) to specify the behavior for their robot. | |||
|
|
|||
| *Op modes* are computer programs that are used to customize the behavior | |||
| *OpModes* are computer programs that are used to customize the behavior | |||
| of a competition robot. The Robot Controller can *execute* a selected op | |||
| mode to perform certain tasks during a match. | |||
| of a competition robot. The Robot Controller can *execute* a selected op | ||
| mode to perform certain tasks during a match. | ||
|
|
||
| Teams who are participating in *FIRST* Tech Challenge have a variety | ||
| of programming tools that they can use to create their own op modes. | ||
| of programming tools that they can use to create their own OpModes. | ||
| Teams can use a visual (“drag and drop”) programming tool called the | ||
| *Blocks Programming Tool* to create their op modes. Teams can also |
| @@ -257,7 +257,7 @@ file. When you first scan for hardware, your Robot Controller should | |||
| detect the Expansion Hub that is immediately connected to the Robot | |||
| Controller via the OTG adapter and USB cable. The Robot Controller will | |||
| automatically label this device as an Expansion Hub “Portal”. The Robot | |||
| Controller will talk through this portal to the individual Expansion | |||
| Controller will controller through this portal to the individual Expansion | |||
There was a problem hiding this comment.
change "controller" to "communicate"
| Let's modify your op mode to control the DC motor that you connected and | ||
| configured for your REV Expansion Hub. Modify the code for the program | ||
| Let's modify your OpMode to control the DC motor that you connected and | ||
| configured for your REV Control Hub or REV Expansion Hub. Modify the code for the program |
| @@ -449,13 +449,13 @@ the op mode, press the square-shaped stop button. | |||
|
|
|||
| | | |||
|
|
|||
| Congratulations! You ran your first java op mode! | |||
| Congratulations! You ran your first java OpMode! | |||
| Your op mode takes input from a gamepad and uses this input to control a | ||
| DC motor. To run your op mode, you will need to connect a Logitech F310 | ||
| Your OpMode takes input from a gamepad and uses this input to control a | ||
| DC motor. To run your OpMode, you will need to connect a Logitech F310 |
There was a problem hiding this comment.
F310 or other approved gamepad
| @@ -538,7 +539,7 @@ adapter cable. | |||
|
|
|||
| | | |||
|
|
|||
| Your example op mode is looking for input from the gamepad designated as | |||
| Your example OpMode is looking for input from the gamepad designated as | |||
| the user or driver #1. Press the Start button and the A button | |||
| simultaneously on the Logictech F310 controller to designate your | |||
There was a problem hiding this comment.
Logitech is misspelled. Also, could consider mentioning the alternate button names on PS2-style gamepads.
| @@ -1,15 +1,15 @@ | |||
| Running Your OpMode (All Languages) | |||
| ----------------------------------- | |||
|
|
|||
| If your op mode requires input from a gamepad, then you will need to | |||
| If your OpMode requires input from a gamepad, then you will need to | |||
| connect a Logitech F310 gamepad to the DRIVER STATION. Note that you can | |||
There was a problem hiding this comment.
...or other approved...
| @@ -25,7 +25,7 @@ need a Micro USB OTG adapter cable. | |||
|
|
|||
| | | |||
|
|
|||
| 2. For the examples in this wiki, the op modes are looking for input | |||
| 2. For the examples in this wiki, the OpModes are looking for input | |||
| from the gamepad designated as the user or driver #1. Press the Start | |||
| button and the A button simultaneously on the Logitech F310 | |||
There was a problem hiding this comment.
consider mentioning PS2-style button names?
| @@ -52,9 +52,9 @@ available op modes that reside on your Robot Controller. | |||
|
|
|||
| | | |||
|
|
|||
| Note that the word "TeleOp" is short for "Tele-Operated" and it implies a driver controlled op mode (i.e., an op mode that gets input from a human driver). | |||
| Note that the word "TeleOp" is short for "Tele-Operated" and it implies a driver controlled OpMode (i.e., an OpMode that gets input from a human driver). | |||
There was a problem hiding this comment.
Can omit the comma after i.e.
uvidyadharan
requested changes
Jan 25, 2025
docs/source/conf.py
Outdated
| @@ -321,6 +321,7 @@ | |||
| ('booklets/sdk', "sdk.tex", 'SDK Guide', author, "manual"), # SDK | |||
| ('robot_building/rev/PowerPlay/part1/index', "rob_building_rev_p1.tex", 'Part 1 - Basic \'Bot Guide for REV', author, "manual"), # REV Bot Building Power Play P1 | |||
| ('manufacturing/3d_printing/index', '3d_printing.tex', '3D Printing Guide', author, "manual"), # 3D Printing | |||
| ('hardware_and_software_configuration/configuring/managing_esd/managing-esd', 'esd.tex', 'Managind Electrostatic Discharge', author, "manual"), # ESD | |||
There was a problem hiding this comment.
Should be "Managing Electrostatic Discharge"
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 FIRST-Tech-Challenge/ftcdocs-private#106