Add better readme

[SeanErn]

Summary by CodeRabbit

• New Features

  • Updated documentation now includes quickstart guides and Javadocs for easier access.
  • Added links to documentation and Javadoc reference in the README.

• Bug Fixes

  • Improved clarity in various documentation sections regarding configuration and testing processes.

• Documentation

  • Added full text of the GNU Lesser General Public License (LGPL) version 3 to the LICENSE file.
  • Enhanced structure and detail in the quickstart guide for robot configuration.

• Chores

  • Updated workflow configuration to restrict documentation job triggers to the master branch.

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

This pull request encompasses multiple changes across the project, focusing on documentation, workflow configuration, and code formatting. The modifications include updating the GitHub Actions workflow to trigger only on the master branch, adding the GNU Lesser General Public License (LGPL) v3 to the project, revising the README with updated links and project name, and making various documentation and code formatting improvements across several files.

Changes

File	Change Summary
.github/workflows/docs.yml	Restricted workflow trigger to master branch only
LICENSE.md	Added full text of GNU Lesser General Public License (LGPL) version 3
README.md	Updated project name to "Alotobots", added documentation and Javadoc links, removed setup instructions
docs/mkdocs/docs/index.md	Simplified introductory text, added links to quickstart and Javadocs
docs/mkdocs/docs/quickstart.md	Extensive revisions to configuration process documentation
Multiple source files	Code formatting improvements, comment refinements

Sequence Diagram

sequenceDiagram
    participant Workflow as GitHub Actions
    participant Repo as Repository
    participant Docs as Documentation Build
    participant Pages as GitHub Pages

    Workflow->>Repo: Checkout repository
    Workflow->>Docs: Set up build environment
    Docs->>Docs: Generate Javadoc
    Docs->>Docs: Build MkDocs site
    Workflow->>Pages: Publish documentation

Loading

The sequence diagram illustrates the documentation publishing workflow, showing how the GitHub Actions process checks out the repository, sets up the build environment, generates documentation, and publishes it to GitHub Pages.

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 327600c and 325d47e.

📒 Files selected for processing (14)

• .github/workflows/docs.yml (1 hunks)
• LICENSE.md (1 hunks)
• README.md (1 hunks)
• docs/mkdocs/docs/index.md (1 hunks)
• docs/mkdocs/docs/library/commands/vision/objectdetection/drivefacingbestobject.md (1 hunks)
• docs/mkdocs/docs/library/commands/vision/objectdetection/pathfindtobestobject.md (1 hunks)
• docs/mkdocs/docs/library/subsystems/vision/apriltag.md (1 hunks)
• docs/mkdocs/docs/library/subsystems/vision/objectdetection.md (1 hunks)
• docs/mkdocs/docs/quickstart.md (4 hunks)
• src/main/java/frc/alotobots/library/subsystems/swervedrive/Module.java (1 hunks)
• src/main/java/frc/alotobots/library/subsystems/vision/photonvision/apriltag/AprilTagSubsystem.java (8 hunks)
• src/main/java/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/commands/DriveFacingBestObject.java (5 hunks)
• src/main/java/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/commands/PathfindToBestObject.java (6 hunks)
• src/main/java/frc/alotobots/library/subsystems/vision/photonvision/objectdetection/constants/ObjectDetectionConstants.java (1 hunks)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.