Create and add diagrams to documentation

airpartners / logger

Code and documentation associated with the air quality data logger/sensor box.

https://github.com/airpartners/logger/wiki

0 stars 0 forks source link

Create and add diagrams to documentation #19

Closed anushadatar closed 3 years ago

anushadatar commented 3 years ago

This is low priority, but has been asked multiple times of me during onboarding for SP21, so we should make some as they'll be useful for troubleshooting as well. I have a few sketches in my notebook and we can talk them through if someone who is not me wants to pick this up (go for it if you'd like!) and would like that perspective. Otherwise, just noting this needs to be done eventually.

anushadatar commented 3 years ago

Required diagrams. Hardware side (to go on hardware overview page):

Component diagram
Individual component diagram (MCPC, Raspi, Motor controller connectors) as labeled pictures Software side (to go on software overview page):
log-and-switch explanation
serialdevices class diagram

I'll update this as I keep thinking of things worth adding.

anushadatar commented 3 years ago

Added diagrams folder to github

anushadatar commented 3 years ago

These look super crusty in dark mode but that's probably not a required thing to fix rn, but let the record show I am aware

anushadatar commented 3 years ago

Done with software diagrams, will add hardware diuagrams in the near future.

anushadatar commented 3 years ago

added photos diagram to github, showing off my passion for graphic design here https://docs.google.com/presentation/d/1IrVTFMlNiK_rmQ--ESAgUP8sEPo5v4seMoUniz0XqTc/edit?usp=sharing

these photos are uniquly horrible but best for now i guess

anushadatar commented 3 years ago

added all the diaghttps://github.com/airpartners/logger/tree/master/images/ https://github.com/airpartners/logger/wiki/hardware-overview https://github.com/airpartners/logger/wiki/software-overview :)rams