Add detailed inline documentation to all team code files#13
Draft
Copilot wants to merge 3 commits into
Draft
Conversation
… and indexerUtil classes Co-authored-by: ngerow2025 <44300132+ngerow2025@users.noreply.github.com>
Co-authored-by: ngerow2025 <44300132+ngerow2025@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add detailed documentation to every line of code
Add detailed inline documentation to all team code files
Mar 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Every source file in the team codebase lacked documentation, making it difficult for new members to understand subsystem behavior, autonomous sequencing, and control flow.
Changes
Subsystems
Actuator,Intake,Outtake,Indexer,Movement,Turret,AntiDefense): class-level JavaDoc explaining hardware wiring, state machines, and tuning knobs; inline comments on every significant lineindexerUtil/(BetterCRControl,CRServoPositionControl,ColorSensorSystem,SlotObservation,SlotState): documented PD control loops, color sensor thresholds, and slot-state transitionslimelight/(Aimer,AprilTag,InertiaAutoAim): documented PIDF bearing controller, anti-windup, derivative smoothing, AprilTag pipeline selection, and field-coordinate conventionsouttakeUtil/RpmController: documented closed-loop RPM control and encoder mathTeleop
Bot: documented FSM states (MotifSelection → Intake → QuickOuttake / SortOuttake / Endgame), all gamepad bindings per state, and every Road RunnerActionsequence builderBotPeriodics,ActionHost,TeleopConstants: documented periodic subsystem update loop, action runner lifecycle, and all tuning constantsMainTeleop,OneDriverTeleop: documented OpMode lifecycle phasesAutonomous
auto/utils/(Action,BotActions,Hardware,Paths): documented action factory methods, sensor-feedback vs. time-based intake strategies, obelisk tag → motif color mapping, and trajectory builder logicauto/opmodes/(FasterRedCloseMotif,FasterRedCloseMotif15,FasterRedCloseMotifLinear,FasterRedClose,FasterBlueClose,FasterBlueCloseMotif,FarLeave): documented full autonomous sequence per OpMode, all@Configtuning fields, and parallelism strategyExample — documented FSM state handler
Not yet documented:
auto/opmodes/TestingOpmode.java(developer scratch OpMode).📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.