Rust Tutorials: Issues and improvements in

Open Beginner friendly
#112 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Review each tutorial section mentioned in the issue (Creating Accounts and Faucets, Mint/Consume/Create Notes, Deploying a Counter Contract, etc.) in the tutorials repository. For each, locate the corresponding Rust code files, identify the specific issues like unused imports, misformatted dependencies, missing imports, and naming inconsistencies. Verify the structure and setup steps for consistency. The work is done when all listed issues are corrected and the tutorials are self-contained as described.

Written by the indexing model from the issue text.

Description

bug documentation
Creating Accounts and Faucets

Issue: There are unused imports present in the Rust code of this tutorial. I suggest removing the unused imports.

Mint, Consume and Create Notes

Issue: Dependencies import misformatted in Rust code.

Deploying a Counter Contract

Issue: Missing NoAuth component import in Rust code.

How to Create Notes with Custom Logic

Issue: Tutorial feels different from others structure-wise. Unlike others, it is missing the set up steps. In my opinion, I think we should include the set-up steps, although present at other tutorials. This is because each tutorial should be able to be used independently from each other.

Foreign Procedure Invocation

Issues:

  • counter_component variable should be renamed to counter_reader_component in Rust code snippet.
  • The code snippet is missing the create_library utility function.
How to Create Notes in Miden Assembly

Issue: The title of this tutorial is confusing, it appears to refer to creating and deploying notes instead of literally creating notes within Miden Assembly code. I think the tutorial should be renamed to something like "How to Create Notes inside the MidenVM using Miden Assembly".

Dominant language
Rust
Stars
18
Forks
34
Avg merge
4d 18h
Merged PRs (30d)
2

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/tutorials

All issues in 0xMiden/tutorials

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.