Skip to content

Commit dd570d1

Browse files
committed
updated for 2026 + some grammar fixes
1 parent 6e0dfe2 commit dd570d1

27 files changed

Lines changed: 148 additions & 136 deletions

docs/contributing/intro.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
There are always going to be improvements, fixes, and updates that can be made to our training material. It's up to team members to make these changes. Detailed in this section is how you can help with these efforts.
22

3+
If you have edited the website, please put the date and your name here:
4+
>Last Updated: March 28, 2026 by Logan Hunt
5+
36
## Setup
47
There are two ways to set up your development environment to work on this website, both of which can give you auto-reload of your local changes.
58

docs/contributing/yearly-checklist.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ These are things that should be checked/changed in the curriculum before pre-sea
1111
- The curriculum is adjusted on difficulty and odd parts are fixed based on trainee input
1212
- Quickly look through the entire site to make sure everything is correct
1313
- Make sure whoever is presenting the presentations in section 1 are familiar with them
14-
- You can coordinate with SenAct on maybe giving the presentation together or having a SenAct team member do the presentation
14+
- You can coordinate with senac on maybe giving the presentation together or having a senac team member do the presentation
1515
- We have the newest and most relevant XKCDs \ (•◡•) /

docs/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# Welcome
22

3-
Hi. Welcome to the programming training docs for Deep Blue Robotics.
3+
Hello. Welcome to the programming training docs for Deep Blue Robotics.
44

55
Before you get started, let me just say this: We are moving at a significantly faster pace than any computer science course offered at the school, and it's okay to get stuck or not know something. The Programming team veterans are here to help, please ask us questions! This is pretty difficult stuff, but I guarantee that it will be worth it and that we'll make it through together.
66

77
Alright, let's get started.
8+
***
9+
>**xkcd #806: Tech Support
10+
>
11+
>![it was all a dream](https://imgs.xkcd.com/comics/tech_support.png)
12+
>
13+
>https://xkcd.com/806

docs/resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
- [Updating Lib199 Video](https://drive.google.com/file/d/1CLS0XMqJ6Y5_mLtYdS3HUR-l4us7WAk-/view)
1919
- [Code Styling Guide](https://docs.google.com/document/d/1RVMY4_c5qCdh_hqiG-O33_-PpMKZtKSpayKp2bSBjTo/edit)
2020
- [Complex Obscure Buxfixes Doc](https://docs.google.com/document/d/1PtT4ICuIJJ_EW_JgU_YRrFyJk2P9CibrkjtXtpVGjXE/edit)
21-
- [List of people's github's usernames, Driver station serial numbers, etc](https://docs.google.com/document/d/1D_4Fbr4ktwU9jl2Mkpw2Kpv0Q4v-NhCO2m5agvL5TfY/edit?usp=sharing)
21+
- [List of people's github's usernames, Driverstation serial numbers, etc](https://docs.google.com/document/d/1D_4Fbr4ktwU9jl2Mkpw2Kpv0Q4v-NhCO2m5agvL5TfY/edit?usp=sharing)
2222

2323
## Helpful Java Websites
2424
- [Code Academy](https://www.codecademy.com/learn/learn-java/modules/learn-java-object-oriented-java-u/cheatsheet)

docs/section-0/java.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,19 @@ Week 3:
2525

2626
## Other Notes
2727

28-
For Inheritance and Polymorphism, a concept they do not cover are interfaces which you may encounter. Read about them [here](https://www.w3schools.com/java/java_interface.asp).
28+
Every year, our training curriculum may change, so there may be some information here that you won't use or information you will need to use but isn't here. Just ask a programming veteran for help and they'll assist you.
29+
30+
For Inheritance and Polymorphism, a concept they do not cover are interfaces which you may encounter, you can read about them [here](https://www.w3schools.com/java/java_interface.asp).
2931

3032
They also do not cover enums. Read more about them [here](https://www.w3schools.com/java/java_enums.asp). One thing they don't mention is that you can actually assign values to your enums such as:
3133

3234
```
33-
public static enum TemperatureLimit {
35+
public static enum MotorConfig {
3436
NEO(70), NEO_550(40);
3537
3638
public final int limit;
3739
38-
private TemperatureLimit(int limit) {
40+
private MotorConfig(int limit) {
3941
this.limit = limit;
4042
}
4143
}
@@ -56,4 +58,4 @@ I highly suggest to look at the website or tutorials online if you don't underst
5658
If you still don't get it, you can always ask a programming veteran for help!
5759

5860
!!! Unfinished
59-
If you see this, tell a programming veteran to add exercises
61+
If you see this, ask a programming veteran to complete it.

docs/section-1/setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Again, follow the instructions for your respective OS to [get Git here](https://
1818

1919
If you do not have a [GitHub](https://github.com) account, create one now.
2020

21-
Once you have your account, tell a programming mentor or programming lead your username so they can add you to our GitHub organization.
22-
2321
Next, set up your username (your real name) and email in Git by following these instructions:
2422

2523
- [Setting your username](https://help.github.com/en/articles/setting-your-username-in-git)
26-
- [Setting your email address](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address)
24+
- [Setting your email address](https://help.github.com/en/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address)
25+
26+
Once you have your account, tell a programming mentor or programming lead your username so they can add you to our GitHub organization.

docs/section-1/version-control.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ So you know how to write Java code, and you know the basics of how our robot cod
55
Once you're done, we'll do some exercises to see if you've got it.
66

77
!!! note
8-
We'll be using [VS Code's built-in version control tools in this tutorial](https://code.visualstudio.com/docs/editor/versioncontrol), but there are many other good tools too, including [Github Desktop](https://desktop.github.com/), [Gitkraken](https://www.gitkraken.com/git-client), and of course, the ol' command line. You don't need to know how to use the command line for FRC, but it's a useful, if not essential, skill if you want to go beyond.
8+
We'll be using VS Code's built-in version control tools in [this tutorial](https://code.visualstudio.com/docs/editor/versioncontrol), but there are many other good tools too, including [Github Desktop](https://desktop.github.com/), [Gitkraken](https://www.gitkraken.com/git-client), and of course, the ol' command line. You don't need to know how to use the command line for FRC, but it's a useful, if not essential, skill if you want to go beyond.
99

1010
Navigate to this [google doc](https://docs.google.com/document/d/1D_4Fbr4ktwU9jl2Mkpw2Kpv0Q4v-NhCO2m5agvL5TfY/edit) and add your gitHub username to the list.
1111

1212
## Practice
13-
VS Code is the text editor we will be using to write and run our code, and should have been installed with the WPILib suite during setup. Open up VS Code and follow the "Cloning a repository" section of [the VS Code git tutorial](https://code.visualstudio.com/docs/editor/versioncontrol#_cloning-a-repository) to clone [this repo](https://github.com/DeepBlueRobotics/training/).
13+
VS Code is the text editor we will be using to write and run our code, and should have been installed with the WPILib suite during setup. Open up VS Code and follow the "Cloning a repository" section of the [VS Code git tutorial](https://code.visualstudio.com/docs/editor/versioncontrol#_cloning-a-repository) to clone [this repository](https://github.com/DeepBlueRobotics/training/).
1414

1515
Have it? I hope so too.
1616

@@ -19,20 +19,20 @@ Make a new branch, whether by VS Code or Github Desktop or anything else, and ti
1919
Go find every single file with the name `intro.md`, and paste your name somewhere over it. Or all over it. Horribly deface that file with your name.
2020
Think of this as a "ritual" of public defacement in order to initiate your learning of Github.
2121

22-
Now stage and commit your changes with the message `add [your name]`, and then push your changes to make the branch public. Refer to the [Git tutorial](https://guides.github.com/introduction/git-handbook/) and [VS Code tutorial](https://code.visualstudio.com/docs/editor/versioncontrol) if needed.
22+
Now stage and commit your changes with the message `added [your name] to intro files`, and then push your changes to make the branch public. Refer to the [Git tutorial](https://guides.github.com/introduction/git-handbook/) and [VS Code tutorial](https://code.visualstudio.com/docs/editor/versioncontrol) if needed.
2323

2424
Great! You now have a crimes done to the training website under your name!
2525
But in order to let us know you did it, go to github and create a "Pull Request" from your branch to the `master` branch. It should look a bit like this:
2626
`base: master <- compare: willsbranch`
2727

2828
!!! question
29-
Why and what is a Pull Request?
30-
A PR (our shorthand for Pull Request) is used to ask for approval to copy the changes of the `compare` branch onto the `base` branch. This is very useful when we want to review people's code before they update the master branch and break the robot, or when a person spends multiple worksessions working on a specific thing and don't want to leave unfinished code on the master branch.
29+
What is a Pull Request?
30+
A pull request (also called a PR) is used to ask for approval to copy the changes of the `compare` branch onto the `base` branch. This is very useful when we want to review people's code before they update the master branch and break the robot, or when a person spends multiple worksessions working on a specific thing and don't want to leave unfinished code on the master branch.
3131

3232
Finish that PR, and we'll delete your branch to clean it up in a few years.
3333

3434
!!! note
3535
If you look at the tutorial above, they mention the "Git: Clone" command from the Command Palette (⇧⌘P). However, it's good practice to use "Git: Clone(Recursive)" instead of just "Git(Clone)" because cloning the repo recursively also clones all the defined submodules in the repo as well.
3636

3737
!!! tip
38-
By convention, commit names are in simple present tense. Things like `add name` or `fix these bugs` or `update readme`. You are expected to write descriptive commit messages that follow this convention.
38+
By convention, commit names are in simple present tense. Things like `add name` or `fix these bugs` or `update readme`.

docs/section-2/electronics.md

Lines changed: 13 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Electronics
22

3-
We have significant overlap with SenAct training. If you want more details on SenAct components you can go through [their Electronics presentation](https://docs.google.com/presentation/d/1Y2GSd2B3aV2_6J5xKNS-_xWRiGW_daArdgr4zasUuno/edit#slide=id.g253cb92c37_0_37). Here, we will cover the parts relevant to programming.
3+
We have significant overlap with senac training. If you want more details on senac components you can go through [their Electronics presentation](https://docs.google.com/presentation/d/1Y2GSd2B3aV2_6J5xKNS-_xWRiGW_daArdgr4zasUuno/edit#slide=id.g253cb92c37_0_37). Here, we will cover the parts relevant to programming.
44

55
### Operator Console and Communication
66
- We use a computer, joysticks, xbox controllers, etc
@@ -12,7 +12,7 @@ We have significant overlap with SenAct training. If you want more details on Se
1212
- Can plug sensors and add-ons onto it
1313
- Can add micro-controllers such as a Raspberry Pi to connect to other devices
1414
- ![RoboRIO Ports](roborio_ports.png)
15-
- The radio is what we use to communicate between the robot and the driver station computer.
15+
- The radio is what we use to communicate between the robot and the driverstation computer.
1616
- Connects to the DS Computer via Wifi, Ethernet, or USB
1717
- ![Status Lights for Radio](radio_status_lights.png)
1818
- The Power Distribution Panel (PDP) / Power Distribution Hub (PDH) gives power to the electrical components.
@@ -23,31 +23,28 @@ We have significant overlap with SenAct training. If you want more details on Se
2323
- Different types of motors have different power and respective motor controllers
2424
- Gears and planetary gearboxes can be used to make the motor turn with more torque or turn faster
2525
- The motors we use are:
26-
- CIM
27-
- Biggest
28-
- Most powerful
29-
- Used for drivetrains and other subsystems which require a lot of torque
30-
- Mini CIMs
31-
- Medium size
32-
- BAG
33-
- Smallest
3426
- NEO
27+
- We almost exclusively use these
28+
- Versatile
3529
- Encoders are built into these
36-
- Comparable to CIMs
3730
- Used for drivetrains and other subsystems which require a lot of torque
31+
- NEO Vortex
32+
- Very similar to normal NEOs
33+
- Motor controller attaches directly to the motor instead of using cables
3834
- NEO 550
35+
- We usually don't use these
3936
- Small
4037
- Used for subsystems other than drivetrains
41-
- The typically motor controllers we use are:
42-
- CANSparkMaxes
43-
- Talon SRXs
38+
- The motor controllers we typically use are:
39+
- SparkMaxes
40+
- SparkFlexes
4441

45-
![CANSparkMax](CANSparkMax.png)
42+
![SparkMax](SparkMax.png)
4643

4744
### Sensors
4845
- Encoders
4946
- Attached to motor or built into motor
50-
- Record how much a motor has spun
47+
- Record how much a motor has spun or its position
5148
- Can find RPM, distance spun, etc
5249
- navX
5350
- Measures the angle turned for the robot

docs/section-2/intro.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,10 @@
44
Before you can effectively program a robot, you need to know what you're programming. This section will teach you about:
55

66
- electronics, including the RoboRIO, motor controllers, sensors
7-
- pneumatics, including the compressor, solenoids, pistons
7+
- usually unsued mechanisms: pneumatics compressor, solenoids, pistons
8+
***
9+
>**xkcd #2083: Laptop Issues**
10+
>
11+
>![laptop issues](https://imgs.xkcd.com/comics/laptop_issues.png)
12+
>
13+
>_<https://xkcd.com/2083>_

0 commit comments

Comments
 (0)