-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementImproves existing functionality or featureImproves existing functionality or featurehelp wantedExtra attention is neededExtra attention is needed
Description
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:
- Architectural overview of the crate and how all of the major modules/structs relate to one another
- 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
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementImproves existing functionality or featureImproves existing functionality or featurehelp wantedExtra attention is neededExtra attention is needed
Type
Projects
Status
No status