diff --git a/README.md b/README.md index 82508f55d..e31f2d1a4 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 diff --git a/choreolib/README.md b/choreolib/README.md index f0976f5cf..a08c7ddb5 100644 --- a/choreolib/README.md +++ b/choreolib/README.md @@ -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. diff --git a/choreolib/py/README.md b/choreolib/py/README.md index f0976f5cf..a08c7ddb5 100644 --- a/choreolib/py/README.md +++ b/choreolib/py/README.md @@ -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. diff --git a/choreolib/py/pyproject.toml b/choreolib/py/pyproject.toml index e9eaf1250..8d8f3951b 100644 --- a/choreolib/py/pyproject.toml +++ b/choreolib/py/pyproject.toml @@ -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 = [ diff --git a/choreolib/src/main/java/choreo/auto/AutoFactory.java b/choreolib/src/main/java/choreo/auto/AutoFactory.java index d78011916..d4110836d 100644 --- a/choreolib/src/main/java/choreo/auto/AutoFactory.java +++ b/choreolib/src/main/java/choreo/auto/AutoFactory.java @@ -26,8 +26,7 @@ /** * A factory used to create {@link AutoRoutine}s and {@link AutoTrajectory}s. * - * @see Auto Routine - * Docs + * @see Auto Routine Docs */ public class AutoFactory { static final AutoRoutine VOID_ROUTINE = diff --git a/choreolib/src/main/java/choreo/auto/AutoTrajectory.java b/choreolib/src/main/java/choreo/auto/AutoTrajectory.java index 19f23f88f..bca733421 100644 --- a/choreolib/src/main/java/choreo/auto/AutoTrajectory.java +++ b/choreolib/src/main/java/choreo/auto/AutoTrajectory.java @@ -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 Event - * Markers in the GUI + * @see Event Markers in the + * GUI */ public Trigger atTime(String eventName) { boolean foundEvent = false; @@ -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 Event - * Markers in the GUI + * @see Event Markers in the + * GUI */ public Trigger atPose(String eventName, double toleranceMeters) { boolean foundEvent = false; @@ -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 Event - * Markers in the GUI + * @see Event Markers in the + * GUI */ public Trigger atPose(String eventName) { return atPose(eventName, DEFAULT_TOLERANCE_METERS); @@ -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 Event - * Markers in the GUI + * @see Event Markers in the + * GUI */ public Trigger atTimeAndPose(String eventName, double toleranceMeters) { return atTime(eventName).and(atPose(eventName, toleranceMeters)); @@ -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 Event - * Markers in the GUI + * @see Event Markers in the + * GUI */ public Trigger atTimeAndPose(String eventName) { return atTimeAndPose(eventName, DEFAULT_TOLERANCE_METERS); @@ -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 Event - * Markers in the GUI + * @see Event Markers in the + * GUI */ public double[] collectEventTimes(String eventName) { return trajectory.getEvents(eventName).stream().mapToDouble(e -> e.timestamp).toArray(); @@ -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 Event - * Markers in the GUI + * @see Event Markers in the + * GUI */ public Pose2d[] collectEventPoses(String eventName) { var times = collectEventTimes(eventName); diff --git a/docs/choreolib/installation.md b/docs/choreolib/installation.md index 14d98ad3a..e8d8f7242 100644 --- a/docs/choreolib/installation.md +++ b/docs/choreolib/installation.md @@ -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). diff --git a/mkdocs.yml b/mkdocs.yml index 6988d0967..0818cf571 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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