Merge pull request #227 from CoinFabrik/226-add-architecture-diagram-…

…to-documentation Add architecture diagram documentation
CoinFabrik · Dec 15, 2023 · c1eb307 · c1eb307
2 parents 2bb03ad + 528b738
commit c1eb307
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ For more information on installation and usage, please refer to the [Getting Sta
 - [Vulnerabilities](https://coinfabrik.github.io/scout/docs/vulnerabilities)
 - [Detectors](https://coinfabrik.github.io/scout/docs/detectors)
 - [Contribute](https://coinfabrik.github.io/scout/docs/contribute)
+- [Architecture](https://coinfabrik.github.io/scout/docs/architecture)
 - [Blog](https://blog.coinfabrik.com/)
 
 Visit [Scout's website](https://coinfabrik.github.io/scout/) to view the full documentation.

diff --git a/assets/scout-architecture.png b/assets/scout-architecture.png
diff --git a/docs/docs/architecture.md b/docs/docs/architecture.md
@@ -0,0 +1,13 @@
+---
+sidebar_position: 5
+---
+
+# Architecture
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/CoinFabrik/scout/main/assets/scout-architecture.png" alt="Scout Architectural Diagram"/>
+</p>
+
+
+Scout is built on Trail of Bits’ [Dylint](https://github.com/trailofbits/dylint), featuring a new set of lints. Dylint is a static analyzer that interfaces with the Rust compiler, providing access to the High-Level Intermediate Representation and the Mid-Level Intermediate Representation. These representations enable the accurate capture of many vulnerabilities. The lints are specifically designed to detect certain vulnerability classes. They are files integrated into the tool during compilation, and adding new lints, or detectors as we call them, is straightforward for any contributor. We have also contributed to the Dylint project, enhancing its capabilities to produce outputs in various formats, including PDF reports.
+