diff --git a/docs/architecture/code_flow.md b/docs/architecture/code_flow.md new file mode 100644 index 0000000..660ed23 --- /dev/null +++ b/docs/architecture/code_flow.md @@ -0,0 +1,32 @@ +# Code Flow Document +## Scope +The purpose of this file is to outline the desired framework of the auton stack (and the simulator + logging capabilities) of the RD25 software on a file level. This document should be referenced when writing new files for this framework. + +## Viewing On VSCode +Install `bierner.markdown-mermaid` from the extension marketplace to render the charts in VSCode markdown preview. + +## Chart! +```mermaid +flowchart LR + Serial --> Sanity_Check + + subgraph Control Loop + Controller --> Pathplanner + end + + Simulator --> Pathplanner + Controller --> Simulator + + + + + Serial --> BuggyState_Republisher + + BuggyState_Republisher --> Pathplanner + BuggyState_Republisher --> Controller + + + + Controller --> Serial + +``` \ No newline at end of file