Skip to content

Commit

Permalink
file level organization (draft 1)
Browse files Browse the repository at this point in the history
TiaSinghania committed Oct 14, 2024
1 parent 89bb787 commit 2ae1480
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/architecture/code_flow.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 2ae1480

Please sign in to comment.