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

Add system architecture and data flow diagrams #73

Open
jhodapp opened this issue Feb 17, 2023 · 0 comments
Open

Add system architecture and data flow diagrams #73

jhodapp opened this issue Feb 17, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement Improves existing functionality or feature help wanted Extra attention is needed

Comments

@jhodapp
Copy link
Member

jhodapp commented Feb 17, 2023

Suggestion / Feature Request

In order to help document design decisions and current state for those already in the project, and to help new developers looking to get involved, add the following diagrams to the Rust docs:

  1. Architectural overview of the crate and how all of the major modules/structs relate to one another
  2. One or more flow charts showing important concepts of how data flows from the high level interfaces down to input/output over the SPI bus

Definition of Done

  • Diagrams have been added to Rust docs
  • Diagrams have been reviewed by Rust Never Sleeps developers less familiar with the crate's inner workings, and have indicated they are helpful in understanding the inner workings
@jhodapp jhodapp added documentation Improvements or additions to documentation enhancement Improves existing functionality or feature help wanted Extra attention is needed labels Feb 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement Improves existing functionality or feature help wanted Extra attention is needed
Projects
Status: No status
Development

No branches or pull requests

1 participant