Skip to content

Commit ce3f7bf

Browse files
Merge pull request #65 from paradoxical-duck/master
A ton of random minor updates
2 parents cf36855 + 8637cc5 commit ce3f7bf

11 files changed

Lines changed: 40 additions & 24 deletions

File tree

File renamed without changes.

‎app/docs/about/page.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ of Java programming in FTC!
1616

1717
## When will it be released?
1818
Apex Pathing is currently not officially released to the public, but it's still in development.
19-
We're aiming to release our first version of Apex Pathing in the next few months, before the Biobuzz FTC season begins.
19+
We're aiming to release our first version of Apex Pathing in the next few months, before the 2026-27 FTC season begins.
2020

2121

2222
## What makes Apex special and different?

‎app/docs/constants/_meta.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ export default {
22
"setup": "Setup",
33
"drivetrains" : "Drivetrain Configuration",
44
"localizers" : "Localizer Configuration",
5-
"followers" : "Follower Configuration"
5+
"followers" : "Follower Configuration",
66
}

‎app/docs/constants/drivetrains/page.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The swerve drivetrain takes multiple arguments in the constants file:
6262
* Trackwidth and wheelbase measurements
6363
* maximum power
6464
* angular offsets for each module
65-
It's structured slightly differently by declaring stuff per module.
65+
Note: The swerve drivetrain constants require declarations grouped together in modules.
6666
```java
6767
public DrivetrainConstants setDrivetrainConstants() { // Any DrivetrainConstants
6868
return new SwerveConstants()

‎app/docs/installation/page.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ Once the cloning process is complete, Android Studio will automatically open the
2828
</Callout>
2929

3030
## Constants Setup
31-
Now that you have the project cloned, head over to the [Constants Setup](/docs/constants/setup/) page to set up your
32-
Constants file and get your robot ready for tuning.
31+
Once you have the project cloned, head over to the [Constants Setup](/docs/constants/setup/) page to commence
32+
the tuning process and set up your Constants file.

‎app/docs/misc/pds/page.mdx‎

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
## What are PDS controllers good for?
55
A PDS controller is a precise alternative to a traditional PID controller. This controller removes the I term which can cause overshoots when it builds up.
6-
It's extremely advantageous for pathing applications, as the S term helps to break through static friction, thus increasing accuracy and precision.
6+
It's extremely advantageous for pathing applications, as the S term helps to break through static friction, thus increasing accuracy and precision. PDS controllers
7+
play a huge role in Apex, helping us achieve exemplarily precise pathing.
78

89
## Overview
910
This controller contains 3 terms:
@@ -23,7 +24,3 @@ generally when tuning it, you want your robot or mechanism to reach the target p
2324

2425
The D term is generally supposed to be a very small number and it's meant to counteract the oscilation that the P term causes.
2526
However, it can also cause extreme oscilation or a slow response time if it's too large. The D term when tuned just right should help your robot to "snap right to the target position"
26-
27-
28-
## What role do PDS controllers play in Apex Pathing?
29-

‎app/docs/tuning/_meta.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ export default {
33
"heading-tuner": "Heading Tuner",
44
"lateral-tuner": "Lateral Tuner",
55
"axial-tuner": "Axial Tuner",
6-
"teleop-test": "Teleop Test",
76
"swerve-offsets": "Swerve Offsets",
7+
"teleop-test": "Teleop Test",
88
"bspline-tuner": "BSpline Tuner"
99
}

‎app/docs/tuning/bspline-tuner/page.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Select the **BSpline Tuner** OpMode on your Driver Station.
1111
Open Panels on your device and adjust the parameters as shown on the [Overview page](/docs/tuning/overview).
1212

1313
### Test as you tune
14-
Use the controls below to test your B-Spline follower tracking. Observe the pathing, adjust the parameters in your constants file, and test again until you are satisfied with the results.
14+
Use the controls below to test your B-Spline follower tracking. Observe the pathing, adjust the parameters in Panels, and continue running the tuner until you are satisfied with the results.
1515

1616
| Button | Action |
1717
|--------|--------|

‎app/docs/tuning/overview/page.mdx‎

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,29 @@ tiny oscilations and allow the robot to coompletely stop.
4141
</Callout>
4242

4343
## Tuning Process -- Mecanum and Tank Drive
44-
Before anything else, the heading controller should be tuned to ensure that the robot can maintain its heading while
45-
tuning the lateral and axial controllers. The heading tuner should be run first, followed by the lateral and axial
46-
tuners in any order.
44+
45+
<Steps>
46+
### Heading Tuner
47+
Start by running the [heading tuner](/docs/tuning/heading-tuner) to tune your heading controller. This is to ensure
48+
that the robot can maintain its heading while running subsequent tuners.
49+
50+
### Axial/Lateral Tuners
51+
Once your heading controller is tuned, you can run the [axial tuner](/docs/tuning/axial-tuner) or the [lateral tuner](/docs/tuning/lateral-tuner)
52+
in any order.
53+
</Steps>
4754

4855
## Tuning Process -- Swerve Drive
49-
The swerve module angle offsets should be debugged prior to running any of the tuners or the tuning won't do anything.
50-
After that, run the standard three tuners.
56+
57+
<Steps>
58+
### Swerve Module Angle Offsets
59+
Start by debugging your [swerve module angle offsets](/docs/tuning/swerve-offsets) before running any tuner. This step is crucial to running Apex on a
60+
Swerve Drive robot.
61+
62+
### Heading Tuner
63+
Start by running the [heading tuner](/docs/tuning/heading-tuner) to tune your heading controller. This is to ensure
64+
that the robot can maintain its heading while running subsequent tuners.
65+
66+
### Axial/Lateral Tuners
67+
Once your heading controller is tuned, you can run the [axial tuner](/docs/tuning/axial-tuner) or the [lateral tuner](/docs/tuning/lateral-tuner)
68+
in any order.
69+
</Steps>

‎app/docs/tuning/swerve-offsets/page.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ import { Steps, Callout} from 'nextra/components'
2121
.setModuleAngleOffset(0) //degrees
2222
```
2323

24-
### After doing this, your robot should be ready to run the teleop test!
24+
### Congratulations! Your robot is now ready to run the TeleOpTest.
2525

2626
</Steps>
2727
<Callout type="info">
28-
After doing this, all the rest of the tuning process should be the same as a mecanum drive!
28+
From this point onwards, the tuning process is the same as any other drivetrain.
2929
</Callout>

0 commit comments

Comments
 (0)