Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tc mux docs #106

Open
wants to merge 12 commits into
base: master
Choose a base branch
from
Open

Tc mux docs #106

wants to merge 12 commits into from

Conversation

Comerm28
Copy link
Contributor

No description provided.

lib/shared_data/include/SharedDataTypes.h Outdated Show resolved Hide resolved
lib/shared_data/include/SharedDataTypes.h Outdated Show resolved Hide resolved
lib/shared_data/include/SharedDataTypes.h Outdated Show resolved Hide resolved
lib/shared_data/include/SharedDataTypes.h Outdated Show resolved Hide resolved
lib/shared_data/include/SharedDataTypes.h Show resolved Hide resolved
lib/systems/include/Controllers/SimpleController.h Outdated Show resolved Hide resolved
lib/systems/include/Controllers/SimpleController.h Outdated Show resolved Hide resolved
lib/systems/include/Controllers/SimpleLaunchController.h Outdated Show resolved Hide resolved
lib/systems/include/Controllers/SimpleLaunchController.h Outdated Show resolved Hide resolved
lib/systems/include/BaseLaunchController.h Outdated Show resolved Hide resolved
lib/shared_data/include/SharedDataTypes.h Show resolved Hide resolved
lib/systems/include/BaseController.h Outdated Show resolved Hide resolved
lib/systems/include/BaseLaunchController.h Show resolved Hide resolved
lib/systems/include/Controllers/CASEControllerWrapper.h Outdated Show resolved Hide resolved
lib/systems/include/TorqueControllerMux.h Outdated Show resolved Hide resolved
lib/systems/include/TorqueControllerMux.h Outdated Show resolved Hide resolved
lib/systems/include/Controllers/SimpleLaunchController.h Outdated Show resolved Hide resolved
lib/shared_data/include/SharedDataTypes.h Outdated Show resolved Hide resolved
@jhwang04
Copy link
Contributor

jhwang04 commented Sep 25, 2024

Good work overall, just take extra care to proofread and edit for clarity. If a spelling mistake slips through occasionally, that's totally fine, but I shouldn't be catching multiple of them per commit. Documentation is important, and we should be writing it clearly and professionally.

And yes, I know I'm being fairly nitpick-y. These restrictions will relax as time goes on, but it's worth taking the extra time to write bulletproof documentation before we move towards HT09 firmware. We've had lengthy ongoing discussions about the obscurity and unreadability of firmware in general, and we need to focus hard on paying off our tech debt while we can. I'm not going to be satisfied with any amount of "we'll fix it later"s at this point in time.

lib/shared_data/include/SharedDataTypes.h Outdated Show resolved Hide resolved
lib/shared_data/include/SharedDataTypes.h Show resolved Hide resolved
lib/shared_data/include/SharedDataTypes.h Show resolved Hide resolved
lib/systems/include/BaseController.h Show resolved Hide resolved
lib/systems/include/BaseController.h Outdated Show resolved Hide resolved
lib/systems/include/BaseLaunchController.h Outdated Show resolved Hide resolved
lib/systems/include/BaseLaunchController.h Outdated Show resolved Hide resolved
lib/systems/include/BaseLaunchController.h Outdated Show resolved Hide resolved
lib/systems/include/CASESystem.h Show resolved Hide resolved
lib/systems/include/Controllers/CASEControllerWrapper.h Outdated Show resolved Hide resolved
@Comerm28 Comerm28 changed the title Tc mux docs - wip Tc mux docs Sep 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants