chore(docs): moving tutorials and quick starts around, spinning off codespaces page

[signorecello]

Please read contributing guidelines and remove this line.

[signorecello]

• chore(docs): moving tutorials and quick starts around, spinning off codespaces page #6777 👈
• master

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @signorecello and the rest of your teammates on Graphite

[AztecBot]

Docs Preview

Hey there! 👋 You can check your preview at https://667b37d6d506d3484137e883--aztec-docs-dev.netlify.app

[AztecBot]

Benchmark results

Metrics with a significant change:

• avm_simulation_time_ms (Token:mint_public): 613 (+909%)
• avm_simulation_time_ms (Token:assert_minter_and_mint): 59.3 (-73%)
• protocol_circuit_witness_generation_time_in_ms (private-kernel-tail-to-public): 8,040 (+18%)

Detailed results

All benchmarks are run on txs on the Benchmarking contract on the repository. Each tx consists of a batch call to create_note and increment_balance, which guarantees that each tx has a private call, a nested private call, a public call, and a nested public call, as well as an emitted private note, an unencrypted log, and public storage read and write.

This benchmark source data is available in JSON format on S3 here.

Proof generation

Each column represents the number of threads used in proof generation.

Metric	1 threads	4 threads	16 threads	32 threads	64 threads
proof_construction_time_sha256_30_ms	11,740	3,152 (+1%)	1,503 (-10%)	1,454 (-4%)	1,554 (-5%)
proof_construction_time_sha256_100_ms	43,987	11,802 (+1%)	5,464 (+1%)	5,411 (-1%)	5,367
proof_construction_time_poseidon_hash_ms	78.0	34.0	34.0	58.0	89.0 (+2%)
proof_construction_time_poseidon_hash_30_ms	1,519	417	200 (+1%)	224 (-2%)	271 (+2%)
proof_construction_time_poseidon_hash_100_ms	5,758	1,579	724	765 (-2%)	797 (+1%)

L2 block published to L1

Each column represents the number of txs on an L2 block published to L1.

Metric	4 txs	8 txs	16 txs
l1_rollup_calldata_size_in_bytes	1,412	1,412	1,412
l1_rollup_calldata_gas	9,476	9,460	9,464
l1_rollup_execution_gas	610,297	610,281	610,285
l2_block_processing_time_in_ms	765	1,420 (+1%)	2,718
l2_block_building_time_in_ms	25,245 (+1%)	52,979 (+4%)	99,263 (+1%)
l2_block_rollup_simulation_time_in_ms	25,244 (+1%)	52,979 (+4%)	99,263 (+1%)
l2_block_public_tx_process_time_in_ms	21,699 (+1%)	48,859 (+4%)	95,575 (+1%)

L2 chain processing

Each column represents the number of blocks on the L2 chain where each block has 8 txs.

Metric	3 blocks	5 blocks
node_history_sync_time_in_ms	7,070 (+1%)	9,910 (+1%)
node_database_size_in_bytes	12,169,296	16,085,072
pxe_database_size_in_bytes	16,254	26,813

Circuits stats

Stats on running time and I/O sizes collected for every kernel circuit run across all benchmarks.

Circuit	simulation_time_in_ms	witness_generation_time_in_ms	proving_time_in_ms	input_size_in_bytes	output_size_in_bytes	proof_size_in_bytes	num_public_inputs	size_in_gates
private-kernel-init	131 (+1%)	472 (+3%)	13,013	20,634	67,190	92,352	2,819	524,288
private-kernel-inner	401 (+3%)	1,332 (+13%)	50,306 (+2%)	94,902	67,190	92,352	2,819	2,097,152
private-kernel-tail	382 (+4%)	1,867 (+6%)	55,625 (+10%)	99,121	71,733	14,912	399	2,097,152
base-parity	6.25 (-1%)	1,908 (+5%)	2,772 (+1%)	128	64.0	2,208	2.00	131,072
root-parity	52.6 (+8%)	77.9 (+6%)	40,130 (-8%)	27,100	64.0	2,720	18.0	2,097,152
base-rollup	8,128 (+4%)	4,998 (+4%)	86,440 (+6%)	170,330	756	3,648	47.0	4,194,304
root-rollup	111 (+1%)	92.8 (+2%)	23,376 (-4%)	25,309	620	3,456	41.0	1,048,576
public-kernel-setup	716 (+2%)	3,805 (+4%)	45,327 (+1%)	116,905	93,334	125,344	3,850	2,097,152
public-kernel-app-logic	625 (+3%)	4,859 (+3%)	48,687 (+4%)	116,905	93,334	125,344	3,850	2,097,152
public-kernel-tail	1,442 (+3%)	35,886 (+6%)	190,221 (-1%)	511,910	10,014	14,912	399	8,388,608
private-kernel-reset-small	602 (+2%)	2,179 (+10%)	48,688 (+8%)	123,313	67,190	92,352	2,819	2,097,152
public-kernel-teardown	616 (+2%)	4,798 (+3%)	48,268 (+1%)	116,905	93,334	125,344	3,850	2,097,152
merge-rollup	28.8	N/A	N/A	16,542	756	N/A	N/A	N/A
private-kernel-tail-to-public	N/A	⚠️ 8,040 (+18%)	101,276 (+5%)	N/A	N/A	125,344	3,850	4,194,304

Stats on running time collected for app circuits

Function	input_size_in_bytes	output_size_in_bytes	witness_generation_time_in_ms	proof_size_in_bytes	proving_time_in_ms	size_in_gates	num_public_inputs
ContractClassRegisterer:register	1,344	9,944	423	N/A	N/A	N/A	N/A
ContractInstanceDeployer:deploy	1,408	9,944	40.2 (+1%)	N/A	N/A	N/A	N/A
MultiCallEntrypoint:entrypoint	1,920	9,944	1,788 (+1%)	N/A	N/A	N/A	N/A
GasToken:deploy	1,376	9,944	980	N/A	N/A	N/A	N/A
SchnorrAccount:constructor	1,312	9,944	1,415 (+1%)	N/A	N/A	N/A	N/A
SchnorrAccount:entrypoint	2,304	9,944	2,954 (+5%)	16,768	55,682 (+2%)	2,097,152	457
Token:privately_mint_private_note	1,280	9,944	1,631 (+2%)	N/A	N/A	N/A	N/A
FPC:fee_entrypoint_public	1,344	9,944	356 (+2%)	16,768	11,093 (-2%)	524,288	457
Token:transfer	1,312	9,944	4,546 (+2%)	16,768	45,799 (-1%)	2,097,152	457
AuthRegistry:set_authorized (avm)	21,043	N/A	N/A	87,200	1,425 (+5%)	N/A	N/A
FPC:prepare_fee (avm)	28,841	N/A	N/A	88,032	5,822 (-1%)	N/A	N/A
Token:transfer_public (avm)	44,971	N/A	N/A	87,865	4,861 (+3%)	N/A	N/A
AuthRegistry:consume (avm)	34,973	N/A	N/A	87,616	3,027 (-3%)	N/A	N/A
FPC:pay_refund (avm)	33,573	N/A	N/A	88,448	11,477 (+5%)	N/A	N/A
Benchmarking:create_note	1,344	9,944	1,501 (+7%)	N/A	N/A	N/A	N/A
SchnorrAccount:verify_private_authwit	1,280	9,944	73.0	N/A	N/A	N/A	N/A
Token:unshield	1,376	9,944	3,681 (-2%)	N/A	N/A	N/A	N/A
FPC:fee_entrypoint_private	1,376	9,944	4,632 (-2%)	N/A	N/A	N/A	N/A

AVM Simulation

Time to simulate various public functions in the AVM.

Function	time_ms	bytecode_size_in_bytes
GasToken:_increase_public_balance	67.7 (-2%)	13,873
GasToken:set_portal	17.5 (+2%)	3,495
Token:constructor	92.8 (+2%)	24,207
FPC:constructor	63.2 (+2%)	13,893
GasToken:mint_public	53.0 (+3%)	10,241
Token:mint_public	⚠️ 613 (+909%)	19,216
Token:assert_minter_and_mint	⚠️ 59.3 (-73%)	13,034
AuthRegistry:set_authorized	34.2 (+8%)	7,869
FPC:prepare_fee	191 (+4%)	15,187
Token:transfer_public	32.7 (-12%)	31,425
FPC:pay_refund	147 (+16%)	20,080
Benchmarking:increment_balance	2,666	15,465
Token:_increase_public_balance	56.7 (+4%)	15,089
FPC:pay_refund_with_shielded_rebate	145 (+2%)	21,167

Public DB Access

Time to access various public DBs.

Function	time_ms
get-nullifier-index	0.163 (+8%)

Tree insertion stats

The duration to insert a fixed batch of leaves into each tree type.

Metric	1 leaves	16 leaves	64 leaves	128 leaves	256 leaves	512 leaves	1024 leaves
batch_insert_into_append_only_tree_16_depth_ms	10.4 (+1%)	16.7	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_count	16.8	31.7	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_16_depth_hash_ms	0.601 (+1%)	0.513	N/A	N/A	N/A	N/A	N/A
batch_insert_into_append_only_tree_32_depth_ms	N/A	N/A	50.2 (+5%)	76.8 (+1%)	133	245	475
batch_insert_into_append_only_tree_32_depth_hash_count	N/A	N/A	95.9	159	287	543	1,055
batch_insert_into_append_only_tree_32_depth_hash_ms	N/A	N/A	0.512 (+5%)	0.471 (+1%)	0.455	0.443	0.443
batch_insert_into_indexed_tree_20_depth_ms	N/A	N/A	61.2 (+3%)	112	185 (+1%)	352	702 (+1%)
batch_insert_into_indexed_tree_20_depth_hash_count	N/A	N/A	109	207	355	691	1,363
batch_insert_into_indexed_tree_20_depth_hash_ms	N/A	N/A	0.518 (+3%)	0.502	0.489 (+1%)	0.477	0.479
batch_insert_into_indexed_tree_40_depth_ms	N/A	N/A	74.2 (+2%)	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_count	N/A	N/A	133	N/A	N/A	N/A	N/A
batch_insert_into_indexed_tree_40_depth_hash_ms	N/A	N/A	0.527 (+2%)	N/A	N/A	N/A	N/A

Miscellaneous

Transaction sizes based on how many contract classes are registered in the tx.

Metric	0 registered classes	1 registered classes
tx_size_in_bytes	85,672	670,983

Transaction size based on fee payment method

| Metric | |
| - | |

[catmcgee]

if we're removing aztecnr and aztecjs from getting-started ( i get) then i'd also remove codespaces and manual install and put these into sandbox guides / reference. just link to them in getting-started.

this way its not overwhelming info & and it means when people click "next" they are linked to the first easy aztecnr tutorial which i like

i really like the js getting-started too. can you put this into tutorials under a new category?

[signorecello]

The reason to have them in getting started is mostly because tooling doesn't fit (well) anywhere else. But yeah I think under Guides -> Dev Environment, by changing that to be "Tooling" or something more descriptive.

The JS getting started is a good idea don't take me wrong, I just feel like we're giving options to a beginner and, even worse, duplicating tutorials. So my reasoning is to have one tutorial, max two, and don't give any options 😈

[signorecello]

So TL;DR @catmcgee and @critesjosh I propose:

• Moving codespaces and manual install in a new or repurposed section under guides, link to them in the getting started
• Leave getting started alone at least until we get a CLI tool again
• Remove everything that is covered in the new tutorial, making sure the extra/advanced/out-of-the-box functionality in the current tutorials goes to its separate how-to guide

Wdyt?

[critesjosh]

Remove everything that is covered in the new tutorial, making sure the extra/advanced/out-of-the-box functionality in the current tutorials goes to its separate how-to guide

@signorecello this makes sense. I'd like to keep the info that's in the aztec.js doc that you are removing somewhere in the docs. Can you add it to another page as part of this PR?

[signorecello]

Yes I'm thinking about merging this PR with the next one on the stack, and I'll make sure of that

[critesjosh]

It looks like the order of the pages/sections in the "tutorial" section got messed up. "Advanced" should be at the bottom.