feat(docs): Add architectural flowchart

grain-lang · Jan 28, 2025 · cc2ab02 · cc2ab02
1 parent c4f638e
commit cc2ab02
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/contributor/compiler_walkthrough.md b/docs/contributor/compiler_walkthrough.md
@@ -6,6 +6,8 @@ We'll largely be following the `next_state` function in [compile.re](https://git
 
 ## An overview of the compiler
 
+![Flowchart illustrating an architectural model of the grain compiler.](grain_architecture.png)
+
 The Grain compiler is a [multi-stage](https://en.wikipedia.org/wiki/Multi-pass_compiler) compiler, which means instead of converting directly from Grain syntax into `wasm` code, we send the input program through multiple phases, transforming from one intermediate representation to the next until we get to the final output. This approach allows us to have a more maintainable compiler and perform deeper analysis of the source code, which lets us provide better errors and better code output.
 
 ## File Structure

diff --git a/docs/contributor/grain_architecture.png b/docs/contributor/grain_architecture.png