docs: Improve Notes & Transactions Quick Start page
- 主要言語
- TypeScript
- スター
- 10
- フォーク
- 50
- 平均マージ
- 22日 23時間
- マージ済み PR(30日)
- 1
説明
## Context
From [devrel#126 feedback](https://github.com/0xMiden/miden-devrel/issues/126#issuecomment-3934020694) by @Dominik1999.
## Improvements needed
- **Add core design principle**: "A transaction is defined as the state transition of a single account" — explains why 2 txs are needed for an asset transfer
- **Terminology**: "Bob's account discovers the note" → "Bob's client discovers the note"
- **Reduce repetition**: Each step repeats account/faucet creation. Consider building incrementally in one `demoX.rs` file
- **Check sync loop**: Is the `consumable_notes.is_empty()` polling loop still needed post-0.13?
- **Expected output**: "Send tokens to Bob" step should also show Bob's token balance
- **Key Takeaways**: Says "Notes enable private asset transfers" but the code uses public notes — fix the inconsistency
コントリビューションガイド
調査の方向性
ドキュメントリポジトリ内の「Notes & Transactions Quick Start」ページを見つけてください。`demoX.rs` のようなファイルにあるデモコードを確認し、現在のフローを理解します。ドキュメントのテキストを更新して、中核となる設計原則を含め、正しい用語を使用し、繰り返しを減らし、公開ノートと非公開ノートについての一貫性を確保します。プロジェクトのバージョンや変更履歴を確認して、`consumable_notes.is_empty()` のポーリングループがまだ必要かどうかを検証します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 活発さ
- 停滞
- 明瞭さ
- 明確に書かれている
- 初心者へのやさしさ
- 70/100