Consolidate documentation (#757)

* Makefile * Consolidate documentation * WIP * WIP * WIP * WIP * WIP * WIP * WIP * WIP * WIP * WIP * cargo fmt * cargo clippy * Disable cargo udeps for aquamarine * Correct doctest attribute * Missing text attribute * Addressed comments * Addressed comments
lambdaclass · Aug 28, 2024 · 354ef2b · 354ef2b
1 parent c3291da
commit 354ef2b
Show file tree

Hide file tree

Showing 22 changed files with 2,125 additions and 1,316 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,6 +12,7 @@ keywords = ["starknet", "cairo", "compiler", "mlir"]
 # https://doc.rust-lang.org/edition-guide/rust-2021/default-cargo-resolver.html
 resolver = "2"
 
+
 [[bin]]
 name = "cairo-native-dump"
 required-features = ["build-cli"]
@@ -52,7 +53,12 @@ with-runtime = ["dep:cairo-native-runtime"]
 with-serde = ["dep:serde"]
 with-cheatcode = []
 
+# the aquamarine dep is only used in docs and cannot be detected as used by cargo udeps
+[package.metadata.cargo-udeps.ignore]
+normal = ["aquamarine"]
+
 [dependencies]
+aquamarine = "0.5.0"
 bumpalo = "3.16.0"
 cairo-lang-compiler = "2.7.1"
 cairo-lang-defs = "2.7.1"

diff --git a/DEVELOPER-GUIDE.md b/DEVELOPER-GUIDE.md