Consolidate documentation

[igaray]

Consolidates all written documentation in rustdoc.

• The makefile now has a new default usage target.
• The aquamarine crate was added as a dependency to render mermaid diagrams in rustdoc comments.
• The README now only contains setup and command line usage information and links to the developer documentation in rustdoc. If the README is rendered online on github it links to the online docs hosted on github pages, but if it is rendered via rustdoc it points to the local documented modules.
• An empty docs module now contains a submodule for each section of the documentation.
• The contents of the README.md and DEVELOPER_GUIDE.md have been moved into their corresponding sections.
• Sections include:
  • Overview
  • Compilation walkthrough
  • Execution walkthrough
  • Gas and builtin accounting
  • Implementing libfuncs
  • Resources on Sierra
  • Resources on MLIR

[github-actions]

✅ Code is now correctly formatted.

[github-actions]

Benchmarking results

Benchmark for program factorial_2M

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	9.794 ± 0.106	9.679	10.065	20.30 ± 0.30
cairo-native (embedded AOT)	3.387 ± 0.016	3.353	3.408	7.02 ± 0.08
cairo-native (embedded JIT using LLVM's ORC Engine)	3.399 ± 0.013	3.381	3.423	7.05 ± 0.07
cairo-native (standalone AOT)	0.653 ± 0.002	0.651	0.657	1.35 ± 0.01
cairo-native (standalone AOT with -march=native)	0.482 ± 0.005	0.480	0.496	1.00

Benchmark for program fib_2M

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	9.635 ± 0.067	9.527	9.733	1182.47 ± 16.03
cairo-native (embedded AOT)	2.895 ± 0.011	2.873	2.911	355.35 ± 4.37
cairo-native (embedded JIT using LLVM's ORC Engine)	2.941 ± 0.024	2.921	2.987	360.96 ± 5.10
cairo-native (standalone AOT)	0.008 ± 0.000	0.008	0.010	1.04 ± 0.02
cairo-native (standalone AOT with -march=native)	0.008 ± 0.000	0.008	0.008	1.00

Benchmark for program logistic_map

Open benchmarks

Command	Mean [s]	Min [s]	Max [s]	Relative
Cairo-vm (Rust, Cairo 1)	5.192 ± 0.037	5.122	5.228	78.54 ± 0.58
cairo-native (embedded AOT)	3.149 ± 0.027	3.115	3.211	47.64 ± 0.42
cairo-native (embedded JIT using LLVM's ORC Engine)	3.259 ± 0.035	3.199	3.303	49.30 ± 0.53
cairo-native (standalone AOT)	0.107 ± 0.000	0.107	0.107	1.62 ± 0.00
cairo-native (standalone AOT with -march=native)	0.066 ± 0.000	0.066	0.066	1.00

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.42%. Comparing base (c3291da) to head (a980042).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #757      +/-   ##
==========================================
- Coverage   88.42%   88.42%   -0.01%     
==========================================
  Files         120      120              
  Lines       35467    35467              
==========================================
- Hits        31362    31361       -1     
- Misses       4105     4106       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.