0xPolygonMiden / miden-base

Core components of the Polygon Miden rollup
MIT License
68 stars 41 forks source link

Include a doc section for "Glossary" #891

Open gubloon opened 4 days ago

gubloon commented 4 days ago

Feature description

I propose to include a new section in our docs for Glossary. The glossary will have all of the main keywords, terms and concepts used across the Miden codebase, in an alphabetical order - so that a new reader can quickly get familiar with the Miden's main concepts and codebase by just glancing through the glossary and also can easily refer them whenever they want.

Some of them can be: AccountId, AdviceProvider, add_tag, asset, AssetVault, air, assembly, block_ref, Blake3_192, Blake3_256, BlockHeader, chiplets, create_note, ecgfp5, epilogue, execute_transaction, fri, input_notes, keccak256, NewTransactionResult, NewSwapTransactionResult, note_ids, NoteType, NoteTag, OutputNote, processor, prover, prologue, ProgramInfo, ProvenTransaction, ProvenTransactionBuilder, remove_tag, Rpo256, Rpx256, RpoRandomCoin, rpo_falcon512, secp256k1, SerializedAccountStub, sha256, stdlib, storage_delta, sync_state, tx_inputs, TransactionTrace, TransactionEvent, TransactionKernel, TransactionWitness, TransactionVerifier, verifier, vault_delta,

Why is this feature needed?

No response