Add better readme

.github/workflows/docs.yml

@@ -1,7 +1,7 @@
 name: Documentation
 on:
   push:
-    branches: ['*']
+    branches: ['master']
 
 jobs:
   docs:

LICENSE.md

@@ -0,0 +1,163 @@
+GNU Lesser General Public License
+=================================
+
+_Version 3, 29 June 2007_
+_Copyright © 2007 Free Software Foundation, Inc. &lt;<http://fsf.org/>&gt;_
+
+Everyone is permitted to copy and distribute verbatim copies
+of this license document, but changing it is not allowed.
+
+
+This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+### 0. Additional Definitions
+
+As used herein, “this License” refers to version 3 of the GNU Lesser
+General Public License, and the “GNU GPL” refers to version 3 of the GNU
+General Public License.
+
+“The Library” refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+An “Application” is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A “Combined Work” is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the “Linked
+Version”.
+
+The “Minimal Corresponding Source” for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The “Corresponding Application Code” for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+### 1. Exception to Section 3 of the GNU GPL
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+### 2. Conveying Modified Versions
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+* **a)** under this License, provided that you make a good faith effort to
+  ensure that, in the event an Application does not supply the
+  function or data, the facility still operates, and performs
+  whatever part of its purpose remains meaningful, or
+
+* **b)** under the GNU GPL, with none of the additional permissions of
+  this License applicable to that copy.
+
+### 3. Object Code Incorporating Material from Library Header Files
+
+The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+* **a)** Give prominent notice with each copy of the object code that the
+  Library is used in it and that the Library and its use are
+  covered by this License.
+* **b)** Accompany the object code with a copy of the GNU GPL and this license
+  document.
+
+### 4. Combined Works
+
+You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+* **a)** Give prominent notice with each copy of the Combined Work that
+  the Library is used in it and that the Library and its use are
+  covered by this License.
+
+* **b)** Accompany the Combined Work with a copy of the GNU GPL and this license
+  document.
+
+* **c)** For a Combined Work that displays copyright notices during
+  execution, include the copyright notice for the Library among
+  these notices, as well as a reference directing the user to the
+  copies of the GNU GPL and this license document.
+
+* **d)** Do one of the following:
+    - **0)** Convey the Minimal Corresponding Source under the terms of this
+      License, and the Corresponding Application Code in a form
+      suitable for, and under terms that permit, the user to
+      recombine or relink the Application with a modified version of
+      the Linked Version to produce a modified Combined Work, in the
+      manner specified by section 6 of the GNU GPL for conveying
+      Corresponding Source.
+    - **1)** Use a suitable shared library mechanism for linking with the
+      Library.  A suitable mechanism is one that **(a)** uses at run time
+      a copy of the Library already present on the user's computer
+      system, and **(b)** will operate properly with a modified version
+      of the Library that is interface-compatible with the Linked
+      Version.
+
+* **e)** Provide Installation Information, but only if you would otherwise
+  be required to provide such information under section 6 of the
+  GNU GPL, and only to the extent that such information is
+  necessary to install and execute a modified version of the
+  Combined Work produced by recombining or relinking the
+  Application with a modified version of the Linked Version. (If
+  you use option **4d0**, the Installation Information must accompany
+  the Minimal Corresponding Source and Corresponding Application
+  Code. If you use option **4d1**, you must provide the Installation
+  Information in the manner specified by section 6 of the GNU GPL
+  for conveying Corresponding Source.)
+
+### 5. Combined Libraries
+
+You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+* **a)** Accompany the combined library with a copy of the same work based
+  on the Library, uncombined with any other library facilities,
+  conveyed under the terms of this License.
+* **b)** Give prominent notice with the combined library that part of it
+  is a work based on the Library, and explaining where to find the
+  accompanying uncombined form of the same work.
+
+### 6. Revised Versions of the GNU Lesser General Public License
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License “or any later version”
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

README.md

@@ -1,27 +1,7 @@
-# 5152 AloToBots
+# 5152 Alotobots
 
-[ASCII ART BANNER PLACEHOLDER]
+The template for our robot code.
 
-## About
+See documentation at: https://5152alotobots.github.io/5152_Template/
 
-FRC Team 5152 AloToBots robot code repository.
-
-## Development Setup
-
-### Prerequisites
-- WPILib 2024
-- Git
-- Gradle 8.5+
-
-### Building
-```bash
-./gradlew build
-```
-
-### Deploying
-```bash
-./gradlew deploy
-```
-
-## License
-This project is licensed under the MIT License - see the LICENSE.txt file for details.
+Javadoc reference: https://5152alotobots.github.io/5152_Template/javadoc/

docs/mkdocs/docs/index.md

@@ -1,3 +1,7 @@
 # Team 5152 Robot Code Documentation
 
-Welcome to the comprehensive documentation for Team 5152's robot code. This documentation provides an in-depth look at our robot's sophisticated control and automation systems.
+Welcome to the comprehensive documentation for Team 5152's robot code.
+
+If you are starting the new season from scratch, checkout the [quickstart guide](/5152_Template/quickstart)
+
+Javadocs can be found [here](/5152_Template/javadoc)

docs/mkdocs/docs/library/commands/vision/objectdetection/drivefacingbestobject.md

@@ -28,4 +28,4 @@ Parameters:
 - Includes brief manual rotation override capability with 0.1s timeout
 - Integrates with both [DriveFacingPose](/5152_Template/library/commands/swerve/drivefacingpose) and [DefaultDrive](/5152_Template/library/commands/swerve/defaultdrive) commands
 
-For detailed method documentation, refer to the [JavaDoc reference](PROJECT_ROOT/javadoc/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/commands/package-summary.html).
+For detailed method documentation, refer to the [JavaDoc reference](PROJECT_ROOT/javadoc/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/commands/package-summary.html).

docs/mkdocs/docs/library/commands/vision/objectdetection/pathfindtobestobject.md

@@ -41,4 +41,4 @@ The command requires proper configuration of:
 - Generates and executes path to approach position
 - Command times out after 0.1 seconds but generated path continues executing
 
-For detailed method documentation, refer to the [JavaDoc reference](PROJECT_ROOT/javadoc/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/commands/package-summary.html).
+For detailed method documentation, refer to the [JavaDoc reference](PROJECT_ROOT/javadoc/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/commands/package-summary.html).

docs/mkdocs/docs/library/subsystems/vision/apriltag.md

@@ -52,4 +52,4 @@ The subsystem includes several safeguards for reliable operation:
 
 ## Related Links
 - [JavaDoc Reference](/5152_Template/javadoc/frc/alotobots/library/subsystems/vision/photonvision/apriltag/package-summary.html)
-- [PhotonVision Documentation](https://docs.photonvision.org/en/latest/)
+- [PhotonVision Documentation](https://docs.photonvision.org/en/latest/)

docs/mkdocs/docs/library/subsystems/vision/objectdetection.md

@@ -44,4 +44,4 @@ The subsystem requires several constants to be configured in the ObjectDetection
 - At least one compatible camera connected and configured
 - WPILib 2024 or newer
 
-For detailed method documentation, refer to the [JavaDoc reference](PROJECT_ROOT/javadoc/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/package-summary.html).
+For detailed method documentation, refer to the [JavaDoc reference](PROJECT_ROOT/javadoc/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/package-summary.html).

docs/mkdocs/docs/quickstart.md

@@ -47,9 +47,9 @@ When starting a new season:
    // In Constants.java
    public static final TunerConstants tunerConstants = new TunerConstants2024();
    // or if using different configurations for simulation:
-   public static final TunerConstants tunerConstants = 
-       Constants.currentMode == Mode.SIM ? 
-           new TunerConstantsSim() : 
+   public static final TunerConstants tunerConstants =
+       Constants.currentMode == Mode.SIM ?
+           new TunerConstantsSim() :
            new TunerConstants2024();
    ```
    This static field is used throughout the codebase to access swerve configurations.
@@ -104,7 +104,7 @@ The swerve drive configuration is generated using Phoenix Tuner X's Swerve Gener
       ```java
       // Replace generated values like:
       public static final int kFrontLeftDriveMotorId = 1;
-      
+
       // With references to Constants:
       public static final int kFrontLeftDriveMotorId = Constants.CanId.FRONT_LEFT_DRIVE_MTR_CAN_ID;
       ```
@@ -129,7 +129,7 @@ After configuring modules and before PID tuning, verify basic functionality:
           .withKV(1.59)
           .withKA(0)
           .withStaticFeedforwardSign(StaticFeedforwardSignValue.UseClosedLoopSign);
- 
+
       // Default drive gains
       private static final Slot0Configs driveGains = new Slot0Configs()
           .withKP(0.1)
@@ -672,7 +672,7 @@ Accurate camera position measurements are critical for AprilTag vision:
         new Transform3d(
             new Translation3d(0.245, 0.21, 0.17),  // X, Y, Z in meters
             new Rotation3d(0, Math.toRadians(-35), Math.toRadians(45))),  // Roll, Pitch, Yaw
-        
+
         // Front Middle Camera
         new Transform3d(
             new Translation3d(0.275, 0.0, 0.189),
@@ -948,5 +948,3 @@ After configuring cameras and game elements:
     - Position jumps: Try decreasing POSITION_MATCH_TOLERANCE
 
 Congratulations! Your project should now be fully configured and tuned for optimal performance.
-
-

src/main/java/frc/alotobots/library/subsystems/swervedrive/Module.java

@@ -86,11 +86,13 @@ public void runCharacterization(double output) {
     io.setDriveOpenLoop(output);
     io.setTurnPosition(new Rotation2d());
   }
-// Replace this to estimate MOI via SysID
-//  public void runCharacterization(double output) {
-//    io.setDriveOpenLoop(output);
-//    io.setTurnPosition(new Rotation2d(constants.LocationX, constants.LocationY).plus(Rotation2d.kCCW_Pi_2));
-//}
+
+  // Replace this to estimate MOI via SysID
+  //  public void runCharacterization(double output) {
+  //    io.setDriveOpenLoop(output);
+  //    io.setTurnPosition(new Rotation2d(constants.LocationX,
+  // constants.LocationY).plus(Rotation2d.kCCW_Pi_2));
+  // }
 
   /** Disables all outputs to motors. */
   public void stop() {