Merge pull request #539 from Sabnock01/sabnock/mdbook-skeleton

📝 docs: `mdbook` skeleton
anthias-labs · Oct 1, 2023 · 9e26acb · 9e26acb
2 parents b4b0d44 + 7c1fba4
commit 9e26acb
Show file tree

Hide file tree

Showing 22 changed files with 49 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -18,4 +18,7 @@ Cargo.lock
 .DS_Store
 arbiter/
 
-.vscode
+.vscode
+
+# mdbook
+book
diff --git a/book.toml b/book.toml
@@ -0,0 +1,6 @@
+[book]
+authors = ["Sabnock01"]
+language = "en"
+multilingual = false
+src = "docs/src"
+title = "Arbiter"
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -0,0 +1,21 @@
+# Summary
+
+- [Introduction](./introduction/introduction.md)
+  - [Anomaly Detection](./introduction/anomaly_detection.md)
+- [Getting Started / Installation](./getting_started/getting_started.md)
+  - [CLI installation with cargo](./getting_started/cargo_install.md)
+  - [Setting up Simulations](./getting_started/simulation.md)
+  - [Configuring Agents](./getting_started/agents.md)
+  - [Examples](./getting_started/examples.md)
+- [Auditing](./auditing/auditing.md)
+  - [Identifying your random variable](./auditing/random_variable.md)
+- [Quantifying Economic Risk / Economic Audits](./economic_risk/economic_risk.md)
+  - [Arbitrage Profit](./economic_risk/arbitrage.md)
+  - [LP Revenue](./economic_risk/lp_revenue.md)
+  - [Fee Growth](./economic_risk/fee_growth.md)
+  - [Frameworks for modeling risk](./economic_risk/modeling_risk.md)
+  - [Jump diffusion](./economic_risk/jump_diffusion.md)
+- [Contributing](./contributing/contributing.md)
+  - [Project Architecture](./contributing/architecture.md)
+  - [Vulnerability Corpus](./contributing/vulnerability_corpus.md)
+  - [Open source and free to use](./contributing/open_source.md)
diff --git a/docs/src/auditing/auditing.md b/docs/src/auditing/auditing.md
@@ -0,0 +1 @@
+# Auditing
diff --git a/docs/src/auditing/random_variable.md b/docs/src/auditing/random_variable.md
@@ -0,0 +1 @@
+# Identifying your random variable
diff --git a/docs/src/contributing/architecture.md b/docs/src/contributing/architecture.md
@@ -0,0 +1 @@
+# Project Architecture
diff --git a/docs/src/contributing/contributing.md b/docs/src/contributing/contributing.md
@@ -0,0 +1 @@
+# Contributing
diff --git a/docs/src/contributing/open_source.md b/docs/src/contributing/open_source.md
@@ -0,0 +1 @@
+# Open source and free to use
diff --git a/vulnerability_corpus.md → .../src/contributing/vulnerability_corpus.md b/vulnerability_corpus.md → .../src/contributing/vulnerability_corpus.md
diff --git a/docs/src/economic_risk/arbitrage.md b/docs/src/economic_risk/arbitrage.md
@@ -0,0 +1 @@
+# Arbitrage Profit
diff --git a/docs/src/economic_risk/economic_risk.md b/docs/src/economic_risk/economic_risk.md
@@ -0,0 +1 @@
+# Quantifying Economic Risk / Economic Audits
diff --git a/docs/src/economic_risk/fee_growth.md b/docs/src/economic_risk/fee_growth.md
@@ -0,0 +1 @@
+# Fee Growth
diff --git a/docs/src/economic_risk/jump_diffusion.md b/docs/src/economic_risk/jump_diffusion.md
@@ -0,0 +1 @@
+# Jump diffusion
diff --git a/docs/src/economic_risk/lp_revenue.md b/docs/src/economic_risk/lp_revenue.md
@@ -0,0 +1 @@
+# LP Revenue
diff --git a/docs/src/economic_risk/modeling_risk.md b/docs/src/economic_risk/modeling_risk.md
@@ -0,0 +1 @@
+# Frameworks for modeling risk
diff --git a/docs/src/getting_started/agents.md b/docs/src/getting_started/agents.md
@@ -0,0 +1 @@
+# Configuring agents
diff --git a/docs/src/getting_started/cargo_install.md b/docs/src/getting_started/cargo_install.md
@@ -0,0 +1 @@
+# CLI installation with cargo
diff --git a/docs/src/getting_started/examples.md b/docs/src/getting_started/examples.md
@@ -0,0 +1 @@
+# Examples
diff --git a/docs/src/getting_started/getting_started.md b/docs/src/getting_started/getting_started.md
@@ -0,0 +1 @@
+# Getting Started
diff --git a/docs/src/getting_started/simulation.md b/docs/src/getting_started/simulation.md
@@ -0,0 +1 @@
+# Setting up Simulations
diff --git a/docs/src/introduction/anomaly_detection.md b/docs/src/introduction/anomaly_detection.md
@@ -0,0 +1 @@
+# Anomaly Detection
diff --git a/docs/src/introduction/introduction.md b/docs/src/introduction/introduction.md
@@ -0,0 +1 @@
+# Introduction