Docs: Add explainer for "Network Accounts" and "Network Transactions"

Open Beginner friendly
#1,817 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

The issue points to two specific documentation pages: one for Network Transactions (miden-base/src/transaction.html) and one for Accounts (miden-base/src/state.html). Start by reading the existing content on those pages to understand the current gaps. Then, look at the source code in the miden-base crate, likely under src/transaction.rs and src/state.rs, to gather details about network accounts and transactions. Write clear explanations for both concepts, ensuring they are helpful for developers building on Miden. Verify the changes by building the docs locally.

Written by the indexing model from the issue text.

Description

documentation

"Network Accounts" and "Network Transactions" are mentioned without having proper explanation, even though they also are a vital part of Miden. Especially for developers who are trying to build on top of our infra.

I propose adding better explanation for both to the docs.

See this page (Network Transactions): https://0xmiden.github.io/miden-docs/imported/miden-base/src/transaction.html#network-transaction

See this page (Accounts): https://0xmiden.github.io/miden-docs/imported/miden-base/src/state.html

Dominant language
Rust
Stars
133
Forks
168
Avg merge
2d 3h
Merged PRs (30d)
93

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from 0xMiden/protocol

All issues in 0xMiden/protocol

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.