From 2ae14804626e5280812c0714e776d567480eea9f Mon Sep 17 00:00:00 2001
From: TiaSinghania <samanvita.singhania@gmail.com>
Date: Mon, 14 Oct 2024 09:34:57 -0700
Subject: [PATCH] file level organization (draft 1)

---
 docs/architecture/code_flow.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 docs/architecture/code_flow.md

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