Skip to content

Commit

Permalink
Switch to choreo.autos within docs in this repository (#955)
Browse files Browse the repository at this point in the history
  • Loading branch information
shueja authored Nov 25, 2024
1 parent 1975bd0 commit 2940dd5
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 24 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Grab the latest release for your platform on the [releases](https://github.com/S

## Usage and Documentation

Check out the [Docs](https://sleipnirgroup.github.io/Choreo), which covers installation, usage, building, and ChoreoLib.
Check out the [Docs](https://choreo.autos), which covers installation, usage, building, and ChoreoLib.

## Robot code integration

Expand All @@ -26,7 +26,7 @@ An example project using Choreo is available [here](https://github.com/SleipnirG
- [src-core](src-core) - Rust code shared between the app and the CLI
- [choreolib](choreolib) - ChoreoLib: robot-side library for loading and following Choreo paths
- [trajoptlib](trajoptlib) - TrajoptLib: library used by Choreo to generate time-optimal trajectories for FRC robots
- [docs](docs) - Source for the [documentation](https://sleipnirgroup.github.io/Choreo)
- [docs](docs) - Source for the [documentation](https://choreo.autos)

## Authors

Expand Down
2 changes: 1 addition & 1 deletion choreolib/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# ChoreoLib

This is the robot-side library for loading and following Choreo paths. See the [Docs](https://sleipnirgroup.github.io/Choreo/choreolib/installation/) for more details.
This is the robot-side library for loading and following Choreo paths. See the [Docs](https://choreo.autos/choreolib/installation/) for more details.
2 changes: 1 addition & 1 deletion choreolib/py/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# ChoreoLib

This is the robot-side library for loading and following Choreo paths. See the [Docs](https://sleipnirgroup.github.io/Choreo/choreolib/installation/) for more details.
This is the robot-side library for loading and following Choreo paths. See the [Docs](https://choreo.autos/choreolib/installation/) for more details.
2 changes: 1 addition & 1 deletion choreolib/py/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ dependencies = [ "robotpy-wpimath" ]
name = "Choreo Development Team"

[project.urls]
Documentation = "https://sleipnirgroup.github.io/Choreo/"
Documentation = "https://choreo.autos/"

[build-system]
requires = [
Expand Down
3 changes: 1 addition & 2 deletions choreolib/src/main/java/choreo/auto/AutoFactory.java
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,7 @@
/**
* A factory used to create {@link AutoRoutine}s and {@link AutoTrajectory}s.
*
* @see <a href="https://sleipnirgroup.github.io/Choreo/choreolib/auto-routines">Auto Routine
* Docs</a>
* @see <a href="https://choreo.autos/choreolib/auto-routines">Auto Routine Docs</a>
*/
public class AutoFactory {
static final AutoRoutine VOID_ROUTINE =
Expand Down
28 changes: 14 additions & 14 deletions choreolib/src/main/java/choreo/auto/AutoTrajectory.java
Original file line number Diff line number Diff line change
Expand Up @@ -394,8 +394,8 @@ public boolean getAsBoolean() {
* @param eventName The name of the event.
* @return A trigger that is true when the event with the given name has been reached based on
* time.
* @see <a href="https://sleipnirgroup.github.io/Choreo/usage/editing-paths/#event-markers">Event
* Markers in the GUI</a>
* @see <a href="https://choreo.autos/usage/editing-paths/#event-markers">Event Markers in the
* GUI</a>
*/
public Trigger atTime(String eventName) {
boolean foundEvent = false;
Expand Down Expand Up @@ -454,8 +454,8 @@ public Trigger atPose(Pose2d pose, double toleranceMeters) {
* @param toleranceMeters The tolerance in meters.
* @return A trigger that is true when the robot is within toleranceMeters of the given events
* pose.
* @see <a href="https://sleipnirgroup.github.io/Choreo/usage/editing-paths/#event-markers">Event
* Markers in the GUI</a>
* @see <a href="https://choreo.autos/usage/editing-paths/#event-markers">Event Markers in the
* GUI</a>
*/
public Trigger atPose(String eventName, double toleranceMeters) {
boolean foundEvent = false;
Expand Down Expand Up @@ -489,8 +489,8 @@ public Trigger atPose(String eventName, double toleranceMeters) {
*
* @param eventName The name of the event.
* @return A trigger that is true when the robot is within 3 inches of the given events pose.
* @see <a href="https://sleipnirgroup.github.io/Choreo/usage/editing-paths/#event-markers">Event
* Markers in the GUI</a>
* @see <a href="https://choreo.autos/usage/editing-paths/#event-markers">Event Markers in the
* GUI</a>
*/
public Trigger atPose(String eventName) {
return atPose(eventName, DEFAULT_TOLERANCE_METERS);
Expand All @@ -507,8 +507,8 @@ public Trigger atPose(String eventName) {
* @param toleranceMeters The tolerance in meters.
* @return A trigger that is true when the event with the given name has been reached based on
* time and the robot is within toleranceMeters of the given events pose.
* @see <a href="https://sleipnirgroup.github.io/Choreo/usage/editing-paths/#event-markers">Event
* Markers in the GUI</a>
* @see <a href="https://choreo.autos/usage/editing-paths/#event-markers">Event Markers in the
* GUI</a>
*/
public Trigger atTimeAndPose(String eventName, double toleranceMeters) {
return atTime(eventName).and(atPose(eventName, toleranceMeters));
Expand All @@ -524,8 +524,8 @@ public Trigger atTimeAndPose(String eventName, double toleranceMeters) {
* @param eventName The name of the event.
* @return A trigger that is true when the event with the given name has been reached based on
* time and the robot is within 3 inches of the given events pose.
* @see <a href="https://sleipnirgroup.github.io/Choreo/usage/editing-paths/#event-markers">Event
* Markers in the GUI</a>
* @see <a href="https://choreo.autos/usage/editing-paths/#event-markers">Event Markers in the
* GUI</a>
*/
public Trigger atTimeAndPose(String eventName) {
return atTimeAndPose(eventName, DEFAULT_TOLERANCE_METERS);
Expand All @@ -536,8 +536,8 @@ public Trigger atTimeAndPose(String eventName) {
*
* @param eventName The name of the event.
* @return An array of all the timestamps of the events with the given name.
* @see <a href="https://sleipnirgroup.github.io/Choreo/usage/editing-paths/#event-markers">Event
* Markers in the GUI</a>
* @see <a href="https://choreo.autos/usage/editing-paths/#event-markers">Event Markers in the
* GUI</a>
*/
public double[] collectEventTimes(String eventName) {
return trajectory.getEvents(eventName).stream().mapToDouble(e -> e.timestamp).toArray();
Expand All @@ -548,8 +548,8 @@ public double[] collectEventTimes(String eventName) {
*
* @param eventName The name of the event.
* @return An array of all the poses of the events with the given name.
* @see <a href="https://sleipnirgroup.github.io/Choreo/usage/editing-paths/#event-markers">Event
* Markers in the GUI</a>
* @see <a href="https://choreo.autos/usage/editing-paths/#event-markers">Event Markers in the
* GUI</a>
*/
public Pose2d[] collectEventPoses(String eventName) {
var times = collectEventTimes(eventName);
Expand Down
4 changes: 2 additions & 2 deletions docs/choreolib/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@

```
# Release
https://sleipnirgroup.github.io/ChoreoLib/dep/ChoreoLib.json
https://lib.choreo.autos/dep/ChoreoLib.json
# Pre-season beta
https://sleipnirgroup.github.io/ChoreoLib/dep/ChoreoLib2025Beta.json
https://lib.choreo.autos/dep/ChoreoLib2025Beta.json
```

The installation method is the same as CTRE, PathPlanner, and more. Read more on Vendor Dependencies and their installation (VSCode → install new library (online)) [here](https://docs.wpilib.org/en/stable/docs/software/vscode-overview/3rd-party-libraries.html#installing-libraries).
Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Project information
site_name: Choreo Documentation
site_url: https://sleipnirgroup.github.io/Choreo/
site_url: https://choreo.autos/
site_description: A graphical tool for planning time-optimized trajectories for autonomous mobile robots in the FIRST Robotics Competition.

# Repository
Expand Down

0 comments on commit 2940dd5

Please sign in to comment.