Skip to content

Commit f9f9cb1

Browse files
committed
link to nextrunner kdoc
Signed-off-by: Zach Harel <zach.harel42@gmail.com>
1 parent 1320d0c commit f9f9cb1

5 files changed

Lines changed: 43 additions & 3 deletions

File tree

src/nextrunner/changes-from-rr.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,28 @@ such as `com.acmerobotics.roadrunner.paths`.
1010
This is similar to, but not the same as, the RoadRunner 0.5 package layout.
1111

1212
Unfortunately, due to this change, NextRunner is not backwards compatible
13-
with RoadRunner 1.0.
13+
with RoadRunner 1.0 (though migration is very easy!).
1414
However, IntelliJ IDEA and Android Studio will automatically import classes,
1515
so you do not need to worry about the package locations.
1616

1717
## 2. Trajectory Creation
1818

19-
The [`Drive` interface](https://javadoc.io/doc/dev.nextftc.nextrunner/ftc/latest/ftc/com.acmerobotics.roadrunner.ftc/-drive/index.html)
19+
The [`Drive` interface](http://rr.zharel.me/ftc/com.acmerobotics.roadrunner.ftc/-drive/index.html)
2020
has a `trajectoryBuilder` method, allowing you to create trajectories without `Action`s.
2121
The API of the [`TrajectoryBuilder` class](https://javadoc.io/doc/dev.nextftc.nextrunner/core/latest/core/com.acmerobotics.roadrunner.trajectories/-trajectory-builder/index.html)
2222
is very similar to that of `TrajectoryActionBuilder`,
2323
but its `build` method returns a `List<Trajectory>` instead of an `Action`.
2424
Alternatively, the `buildToComposite` method returns a `CompositeTrajectory` object,
2525
which may be easier to use.
2626

27+
We also offer methods to create and profile paths without a builder,
28+
which is documented [here](traj-generation)
2729

30+
## 3. Action Improvements
31+
32+
NextRunner includes multiple improvements to RoadRunner's Action framework.
33+
Notably, it includes an `ActionRunner` object to manage asynchronous action queues,
34+
and requirements and interruption features for `Action`s themselves.
35+
36+
The [Creating](actions/creating-actions) and [Using Actions](actions/using-actions)
37+
guides explain many of these features.

src/nextrunner/examples/action-builder.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Both `TankDrive` and `MecanumDrive` have an `actionBuilder` method,
66
with an optional `startPose: Pose2d` parameter.
77
If `startPose` is not provided, it defaults to `localizer.pose`.
88

9+
[All of the `TrajectoryActionBuilder` functions are documented here.](http://rr.zharel.me/actions/com.acmerobotics.roadrunner.actions/-trajectory-action-builder/index.html)
10+
911
Here is an example of how to use `actionBuilder`:
1012

1113
:::tabs key:code

src/nextrunner/examples/follower.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ which will eventually be discussed on a page of this guide.
1616
The following (haha) example uses `TimeFollower`,
1717
but it can be switched out for `DisplacementFollower` with no other changes to the `OpMode`.
1818

19+
[All of the `TrajectoryBuilder` functions are documented here](http://rr.zharel.me/core/com.acmerobotics.roadrunner.trajectories/-trajectory-builder/index.html).
20+
1921
:::tabs key:code
2022

2123
== Kotlin

src/nextrunner/index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,34 @@ Then, sync your project with Gradle files.
6969
>
7070
> The compatibility module is currently compatible with NextFTC 0.6.1 and 0.6.2.
7171
72+
## Updating From RoadRunner 1.0
73+
74+
NextRunner's API is mostly compatible with RoadRunner code,
75+
though package locations were changed.
76+
Simply replace your RoadRunner imports with the following:
77+
78+
```groovy
79+
implementation 'dev.nextftc.nextrunner:core:<latest>>'
80+
implementation 'dev.nextftc.nextrunner:actions:<latest>'
81+
implementation 'dev.nextftc.nextrunner:ftc:<latest>'
82+
```
83+
84+
And sync your project with Gradle files.
85+
86+
> [!WARNING]
87+
> You will need to remove all of the RoadRunner imports from your files
88+
> and replace them with NextRunner's.
89+
> Once you delete the import statements, IntelliJ and Android Studio
90+
> can automatically replace them.
91+
7292
## Tuning
7393

7494
If you are using the QuickStart, the tuning process is
7595
the exact same as the [RoadRunner 1.0 tuning process](https://rr.brott.dev/docs/v1-0/tuning/).
7696
Future changes to the tuning process will be listed here.
97+
98+
## KDoc
99+
100+
[KDoc for NextRunner can be found here](http://rr.zharel.me/).
101+
We recommend checking the KDoc pages,
102+
as they include many features not directly discussed here.

src/nextrunner/traj-generation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ We recommend using the `trajectoryBuilder` API's
8585

8686
## Types of `PosePath`
8787

88-
NextRunner also includes [three default functions](https://javadoc.io/static/dev.nextftc.nextrunner/core/2.4.0/core/com.acmerobotics.roadrunner.paths/-position-path/index.html#-1473791754%2FFunctions%2F-431355489)
88+
NextRunner also includes [three default functions](http://rr.zharel.me/core/com.acmerobotics.roadrunner.paths/-position-path/index.html#1182961430%2FFunctions%2F-431355489)
8989
in the `PositionPath` interface to add heading paths,
9090
which creates `PosePath` objects!
9191

0 commit comments

Comments
 (0)