Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include a doc section for "Glossary" #891

Open
gubloon opened this issue Sep 23, 2024 · 0 comments
Open

Include a doc section for "Glossary" #891

gubloon opened this issue Sep 23, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@gubloon
Copy link
Contributor

gubloon commented Sep 23, 2024

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

@gubloon gubloon added enhancement New feature or request documentation Improvements or additions to documentation labels Sep 23, 2024
@gubloon gubloon self-assigned this Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant