From fb15e65fa857402e2633d364c6e8abe18a68329f Mon Sep 17 00:00:00 2001 From: "SeanErn (aider)" Date: Thu, 5 Dec 2024 16:06:51 -0500 Subject: [PATCH] docs: Refactor index.md to use narrative documentation style --- docs/mkdocs/docs/index.md | 35 ++++++++++------------------------- 1 file changed, 10 insertions(+), 25 deletions(-) diff --git a/docs/mkdocs/docs/index.md b/docs/mkdocs/docs/index.md index ee3d8b98..feac7a6b 100644 --- a/docs/mkdocs/docs/index.md +++ b/docs/mkdocs/docs/index.md @@ -1,36 +1,21 @@ # Team 5152 Robot Code Documentation -Welcome to the comprehensive documentation for Team 5152's robot code. This documentation provides detailed information about our robot's systems, subsystems, and commands. +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. ## Core Systems -### Drive Systems -- [SwerveDrive Subsystem](./library/subsystems/swerve.md) - Advanced omnidirectional drive control -- [Controls System](./game/subsystems/controls.md) - Driver input processing with deadband handling -- Autonomous path following and trajectory generation +Our robot's drive system is built around an advanced [SwerveDrive Subsystem](./library/subsystems/swerve.md) that provides precise omnidirectional control. This integrates seamlessly with our [Controls System](./game/subsystems/controls.md), which handles driver input processing and sophisticated deadband management. The drive system also incorporates autonomous path following and trajectory generation capabilities for consistent, repeatable performance. -### Vision Processing -- [AprilTag System](./library/subsystems/vision/apriltag.md) - Field-relative pose estimation -- [Object Detection](./library/subsystems/vision/objectdetection.md) - Game piece tracking -- Multi-camera fusion and filtering +Vision processing forms another cornerstone of our robot's capabilities. The [AprilTag System](./library/subsystems/vision/apriltag.md) provides field-relative pose estimation, while our [Object Detection](./library/subsystems/vision/objectdetection.md) system enables real-time game piece tracking. These systems work together through multi-camera fusion and filtering to maintain accurate spatial awareness during matches. -### Game-Specific Commands -- [DriveFacingBestObject](./library/commands/drivefacingbestobject.md) - Assisted game piece targeting -- [PathfindToBestObject](./library/commands/pathfindtobestobject.md) - Autonomous game piece approach -- [DefaultSetToAllianceColor](./library/commands/defaultsettoalliancecolor.md) - Alliance indicator control +## Game-Specific Features -### Support Systems -- [Pneumatics Control](./library/subsystems/pneumatics.md) - Actuator and pressure management -- [LED Notification](./library/subsystems/bling.md) - Visual state indication and debugging +We've developed several specialized commands to enhance game performance. The [DriveFacingBestObject](./library/commands/drivefacingbestobject.md) command provides assisted game piece targeting, while [PathfindToBestObject](./library/commands/pathfindtobestobject.md) enables autonomous navigation to game pieces. Our [DefaultSetToAllianceColor](./library/commands/defaultsettoalliancecolor.md) command manages alliance-specific indicators. -## Developer Resources +## Support Infrastructure + +Supporting these primary systems, our robot includes comprehensive [Pneumatics Control](./library/subsystems/pneumatics.md) for actuator and pressure management, along with an [LED Notification System](./library/subsystems/bling.md) that provides clear visual feedback about robot state and debugging information. -### Quick Links -- [JavaDoc API Documentation](./javadoc/) - Detailed API reference -- [Source Code on GitHub](https://github.com/5152Alotobots/5152_Template) +## Developer Resources -### Key Features -- Sophisticated swerve drive control with field-relative operation -- Advanced vision processing with multi-camera support -- Comprehensive telemetry and debugging systems -- Modular command-based architecture +For detailed technical information, developers can access our [JavaDoc API Documentation](./javadoc/) and review our source code directly on [GitHub](https://github.com/5152Alotobots/5152_Template). Our codebase emphasizes modular design through a command-based architecture, making it easy to extend and maintain. The system includes comprehensive telemetry and debugging capabilities, ensuring smooth development and testing processes.