0xMiden / 0xMiden/docs

[Docs] Missing Rust code examples in Accounts quickstart page

オープン 初心者向け
#162 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
主要言語
TypeScript
スター
10
フォーク
50
平均マージ
22日 23時間
マージ済み PR(30日)
1

説明

## Summary

The Accounts quickstart page (`docs/builder/quick-start/accounts.md`) provides Rust environment setup instructions but then only includes TypeScript code examples, leaving Rust developers with a dead end.

## Problem

The page instructs Rust users to set up their environment:

```bash
touch src/bin/demo.rs
cargo run --bin demo --release
```

It then presents tabbed code examples (TypeScript/Rust) for "Creating Accounts Programmatically" and "Creating a Token Faucet." However, the Rust tab appears to be empty or missing actual code, while the TypeScript tab has complete working examples.

A developer following the Rust path would:
1. Set up their Rust binary as instructed
2. Click the "Rust" tab for the code example
3. Find no code to put in the file they just created

## Suggested Fix

Add complete Rust code examples for the "Creating Accounts Programmatically" and "Creating a Token Faucet" sections, matching the pattern already used in the Notes & Transactions page (`notes.md`) which does include full Rust examples using `AccountBuilder`, `ClientBuilder`, etc.

The Rust examples in `notes.md` (mint.rs, consume.rs, send.rs) already demonstrate the same account creation flow and could serve as a reference for the missing code.

コントリビューションガイド

コントリビューションガイドを開く

調査の方向性

docs/builder/quick-start/notes.md(mint.rs、consume.rs、send.rs)にある既存のRustの例を調べて、AccountBuilderとClientBuilderを使用するパターンを理解します。次に、accounts.mdファイルを更新して、「Creating Accounts Programmatically」と「Creating a Token Faucet」のセクションに不足しているRustのコードスニペットを追加し、それらがTypeScriptの例と構造および機能が一致するようにします。変更をローカルでドキュメントをビルドして確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
rust
領域
documentation
issue の種類
ドキュメント
難易度
2/5
見積もり時間
1〜3時間
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
70/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。