wpilibsuite / frc-docs

Official FRC Documentation powered by Read the Docs
https://docs.wpilib.org
Other
150 stars 264 forks source link

Idiomatic Code Architecture Articles #1844

Open modelmat opened 2 years ago

modelmat commented 2 years ago

Just putting this here as a meta-ish/scratchpad issue, since this is something that is really missing from the documentation.

Related issues/PR:

Things to cover:

Reference discord discussion: https://discord.com/channels/176186766946992128/368993897495527424/992645487280783471

calcmogul commented 2 years ago

Relevant robot code idioms (not just architecture) include:

  1. How do I move a motor at the speed specified by an Xbox controller axis?
  2. How do I move a motor while a button is held? (e.g., intake/outtake)
  3. How do I toggle a solenoid with a button? (e.g., intake deploy/stow)
  4. How do I move a motor from one position to another?
Starlight220 commented 2 years ago

I think a lot of robot code idioms might be better covered by examples rather than articles. Architecture is more philosophical/theoretical and up for debate/personal preference, so it is fitting for articles.