docs: Improve Notes & Transactions Quick Start page
- Lenguaje dominante
- TypeScript
- Estrellas
- 10
- Forks
- 50
- Merge medio
- 22 d 23 h
- PR fusionados (30 d)
- 1
Descripción
## 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
Guía de contribución
Línea de trabajo
Encuentre la página 'Notes & Transactions Quick Start' en el repositorio de documentación. Revise el código de demostración, probablemente en un archivo como `demoX.rs`, para comprender el flujo actual. Actualice el texto de la documentación para incluir el principio de diseño central, la terminología correcta, reducir la repetición y garantizar la coherencia sobre las notas públicas frente a las privadas. Verifique si el bucle de sondeo `consumable_notes.is_empty()` sigue siendo necesario consultando la versión del proyecto o el registro de cambios.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 70/100