Skip to content

Commit 528b738

Browse files
committed
Add architecture diagram documentation
1 parent e9ba4f6 commit 528b738

File tree

3 files changed

+14
-0
lines changed

3 files changed

+14
-0
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ For more information on installation and usage, please refer to the [Getting Sta
4141
- [Vulnerabilities](https://coinfabrik.github.io/scout/docs/vulnerabilities)
4242
- [Detectors](https://coinfabrik.github.io/scout/docs/detectors)
4343
- [Contribute](https://coinfabrik.github.io/scout/docs/contribute)
44+
- [Architecture](https://coinfabrik.github.io/scout/docs/architecture)
4445
- [Blog](https://blog.coinfabrik.com/)
4546

4647
Visit [Scout's website](https://coinfabrik.github.io/scout/) to view the full documentation.

assets/scout-architecture.png

59.5 KB
Loading

docs/docs/architecture.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
sidebar_position: 5
3+
---
4+
5+
# Architecture
6+
7+
<p align="center">
8+
<img src="https://raw.githubusercontent.com/CoinFabrik/scout/main/assets/scout-architecture.png" alt="Scout Architectural Diagram"/>
9+
</p>
10+
11+
12+
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.
13+

0 commit comments

Comments
 (0)