Consolidate documentation

[JulianGCalderon]

Consolidate documentation

This PR consolidates documentation from other repositories into the docs directory.

Description

• Adds tooling section to documentation, linking to the auxiliary crates
• Adds How does the VM work? section, explaining core VM concepts. It was taken from https://github.com/lambdaclass/cairo-vm_in_go

[github-actions]

**Hyper Thereading Benchmark results**




hyperfine -r 2 -n "hyper_threading_main threads: 1" 'RAYON_NUM_THREADS=1 ./hyper_threading_main' -n "hyper_threading_pr threads: 1" 'RAYON_NUM_THREADS=1 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 1
  Time (mean ± σ):     33.254 s ±  0.068 s    [User: 32.524 s, System: 0.728 s]
  Range (min … max):   33.206 s … 33.302 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 1
  Time (mean ± σ):     33.048 s ±  0.045 s    [User: 32.269 s, System: 0.776 s]
  Range (min … max):   33.016 s … 33.080 s    2 runs
 
Summary
  'hyper_threading_pr threads: 1' ran
    1.01 ± 0.00 times faster than 'hyper_threading_main threads: 1'




hyperfine -r 2 -n "hyper_threading_main threads: 2" 'RAYON_NUM_THREADS=2 ./hyper_threading_main' -n "hyper_threading_pr threads: 2" 'RAYON_NUM_THREADS=2 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 2
  Time (mean ± σ):     17.775 s ±  0.020 s    [User: 31.181 s, System: 0.754 s]
  Range (min … max):   17.761 s … 17.789 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 2
  Time (mean ± σ):     17.763 s ±  0.039 s    [User: 31.008 s, System: 0.795 s]
  Range (min … max):   17.736 s … 17.791 s    2 runs
 
Summary
  'hyper_threading_pr threads: 2' ran
    1.00 ± 0.00 times faster than 'hyper_threading_main threads: 2'




hyperfine -r 2 -n "hyper_threading_main threads: 4" 'RAYON_NUM_THREADS=4 ./hyper_threading_main' -n "hyper_threading_pr threads: 4" 'RAYON_NUM_THREADS=4 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 4
  Time (mean ± σ):     12.772 s ±  0.175 s    [User: 43.787 s, System: 0.913 s]
  Range (min … max):   12.649 s … 12.896 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 4
  Time (mean ± σ):     12.201 s ±  0.142 s    [User: 43.902 s, System: 0.963 s]
  Range (min … max):   12.101 s … 12.301 s    2 runs
 
Summary
  'hyper_threading_pr threads: 4' ran
    1.05 ± 0.02 times faster than 'hyper_threading_main threads: 4'




hyperfine -r 2 -n "hyper_threading_main threads: 6" 'RAYON_NUM_THREADS=6 ./hyper_threading_main' -n "hyper_threading_pr threads: 6" 'RAYON_NUM_THREADS=6 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 6
  Time (mean ± σ):     12.376 s ±  0.084 s    [User: 43.984 s, System: 0.967 s]
  Range (min … max):   12.317 s … 12.436 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 6
  Time (mean ± σ):     12.211 s ±  0.157 s    [User: 43.879 s, System: 1.016 s]
  Range (min … max):   12.100 s … 12.323 s    2 runs
 
Summary
  'hyper_threading_pr threads: 6' ran
    1.01 ± 0.01 times faster than 'hyper_threading_main threads: 6'




hyperfine -r 2 -n "hyper_threading_main threads: 8" 'RAYON_NUM_THREADS=8 ./hyper_threading_main' -n "hyper_threading_pr threads: 8" 'RAYON_NUM_THREADS=8 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 8
  Time (mean ± σ):     11.950 s ±  0.121 s    [User: 44.520 s, System: 1.002 s]
  Range (min … max):   11.864 s … 12.035 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 8
  Time (mean ± σ):     11.917 s ±  0.054 s    [User: 44.448 s, System: 0.980 s]
  Range (min … max):   11.879 s … 11.955 s    2 runs
 
Summary
  'hyper_threading_pr threads: 8' ran
    1.00 ± 0.01 times faster than 'hyper_threading_main threads: 8'




hyperfine -r 2 -n "hyper_threading_main threads: 16" 'RAYON_NUM_THREADS=16 ./hyper_threading_main' -n "hyper_threading_pr threads: 16" 'RAYON_NUM_THREADS=16 ./hyper_threading_pr'
Benchmark 1: hyper_threading_main threads: 16
  Time (mean ± σ):     12.011 s ±  0.165 s    [User: 44.640 s, System: 1.051 s]
  Range (min … max):   11.895 s … 12.128 s    2 runs
 
Benchmark 2: hyper_threading_pr threads: 16
  Time (mean ± σ):     12.044 s ±  0.105 s    [User: 44.533 s, System: 1.106 s]
  Range (min … max):   11.970 s … 12.119 s    2 runs
 
Summary
  'hyper_threading_main threads: 16' ran
    1.00 ± 0.02 times faster than 'hyper_threading_pr threads: 16'

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.32%. Comparing base (159f67d) to head (7a44362).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1866   +/-   ##
=======================================
  Coverage   96.32%   96.32%           
=======================================
  Files         102      102           
  Lines       40315    40315           
=======================================
  Hits        38832    38832           
  Misses       1483     1483           

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

[github-actions]

Benchmark Results for unmodified programs 🚀

Command	Mean [s]	Min [s]	Max [s]	Relative
base big_factorial	2.518 ± 0.056	2.462	2.601	1.01 ± 0.03
head big_factorial	2.503 ± 0.033	2.453	2.570	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base big_fibonacci	2.457 ± 0.042	2.405	2.517	1.01 ± 0.02
head big_fibonacci	2.423 ± 0.031	2.394	2.490	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base blake2s_integration_benchmark	9.325 ± 0.370	9.070	10.328	1.02 ± 0.04
head blake2s_integration_benchmark	9.127 ± 0.120	9.005	9.298	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base compare_arrays_200000	2.573 ± 0.045	2.522	2.685	1.00
head compare_arrays_200000	2.581 ± 0.058	2.516	2.708	1.00 ± 0.03

Command	Mean [s]	Min [s]	Max [s]	Relative
base dict_integration_benchmark	1.682 ± 0.014	1.656	1.706	1.01 ± 0.02
head dict_integration_benchmark	1.668 ± 0.024	1.650	1.726	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base field_arithmetic_get_square_benchmark	1.418 ± 0.013	1.398	1.434	1.00
head field_arithmetic_get_square_benchmark	1.426 ± 0.016	1.407	1.468	1.01 ± 0.01

Command	Mean [s]	Min [s]	Max [s]	Relative
base integration_builtins	9.207 ± 0.088	9.059	9.290	1.00 ± 0.02
head integration_builtins	9.199 ± 0.133	9.052	9.461	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base keccak_integration_benchmark	9.595 ± 0.440	9.347	10.812	1.01 ± 0.05
head keccak_integration_benchmark	9.515 ± 0.090	9.425	9.641	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base linear_search	2.571 ± 0.036	2.519	2.622	1.01 ± 0.02
head linear_search	2.552 ± 0.025	2.517	2.581	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base math_cmp_and_pow_integration_benchmark	1.737 ± 0.024	1.708	1.776	1.00
head math_cmp_and_pow_integration_benchmark	1.763 ± 0.064	1.699	1.890	1.02 ± 0.04

Command	Mean [s]	Min [s]	Max [s]	Relative
base math_integration_benchmark	1.698 ± 0.015	1.672	1.726	1.01 ± 0.01
head math_integration_benchmark	1.686 ± 0.015	1.663	1.702	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base memory_integration_benchmark	1.440 ± 0.036	1.412	1.531	1.00
head memory_integration_benchmark	1.445 ± 0.030	1.412	1.522	1.00 ± 0.03

Command	Mean [s]	Min [s]	Max [s]	Relative
base operations_with_data_structures_benchmarks	1.815 ± 0.022	1.795	1.865	1.01 ± 0.02
head operations_with_data_structures_benchmarks	1.804 ± 0.021	1.785	1.849	1.00

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
base pedersen	594.2 ± 3.1	589.9	599.4	1.00
head pedersen	597.4 ± 4.3	593.6	607.7	1.01 ± 0.01

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
base poseidon_integration_benchmark	705.9 ± 8.0	696.9	725.2	1.00 ± 0.01
head poseidon_integration_benchmark	705.4 ± 6.9	699.1	720.0	1.00

Command	Mean [s]	Min [s]	Max [s]	Relative
base secp_integration_benchmark	2.081 ± 0.025	2.051	2.127	1.00 ± 0.01
head secp_integration_benchmark	2.078 ± 0.018	2.051	2.109	1.00

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
base set_integration_benchmark	704.3 ± 4.8	696.1	709.7	1.00
head set_integration_benchmark	706.5 ± 8.8	696.0	727.3	1.00 ± 0.01

Command	Mean [s]	Min [s]	Max [s]	Relative
base uint256_integration_benchmark	5.048 ± 0.069	4.976	5.180	1.00 ± 0.02
head uint256_integration_benchmark	5.044 ± 0.051	4.948	5.100	1.00