0xMiden / 0xMiden/protocol

Docs: Assets Page improvements

Abierto
#1,827 5 comentarios 1 reacción 0 asignados Ver en GitHub
documentation
Lenguaje dominante
Rust
Estrellas
132
Forks
167
Merge medio
1 d 23 h
PR fusionados (30 d)
110

Descripción

This issue refers to the following page: https://0xmiden.github.io/miden-docs/imported/miden-base/src/account/overview.html

There are multiple things that can be improved on the Accounts page documentation. Here's a list:

### 1. Title and Smart Contract Clarification

**Issues:**
- Change title from current to just "Accounts"
- Not clear that Accounts are Smart Contracts, especially confusing for Ethereum developers who distinguish between EOAs and Smart Contracts
- **Suggested improvement:**
```
An Account represents the primary entity in Miden. All accounts are smart contracts, programmable entities capable of holding assets, storing data, and executing code. Each Account is a smart contract with a programmable interface through which note scripts (logic attached to messages/notes) and transaction scripts (logic executed during a transaction) can interact with the account's state and assets. By executing transactions against an account, its state can be modified.
```

### 2. SWAP Notes Example

**Issue:** "Two SWAP notes matched together" explanation unclear
- **Suggested improvement:** "For example, if two trade orders are matched entirely within existing notes without altering the account's vault or storage"

### 3. Asset Encoding Explanation

**Issue:** Page doesn't explain how "encoding" of assets works, making fungible/non-fungible distinction unclear
- **Action needed:** Add disclaimer about how encoding works to improve clarity of asset type distinctions

### 4. Native Asset definition

**Issue:** "Native asset" definition needs clarification
- **Suggested improvement:**
```
A native asset is one that follows Miden's standard encoding, issuance, and storage rules. This makes it directly compatible with the protocol's asset-handling functions and guarantees it can be stored in accounts and notes without custom logic.
```

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.