0xMiden / 0xMiden/docs

[Docs] Incomplete TODO placeholder in 'Develop Miden in Rust' guide (v0.12)

Aperta Adatta ai principianti
#163 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
TypeScript
Stelle
10
Fork
50
Merge medio
22g 23h
PR unite (30g)
1

Descrizione

## Summary

The "Develop Miden in Rust" compiler guide (`versioned_docs/version-0.12/compiler/guides/develop_miden_in_rust.md`) contains an unresolved TODO placeholder in published documentation.

## Problem

The guide states:

> TODO: Add examples of using operations on `Felt` type and available functions (`assert*`, etc.)

This is a development placeholder that was published as-is. The guide covers `Felt` initialization (`felt!` macro and `Felt::new`) but stops short of documenting:

- Arithmetic operations on `Felt` (`+`, `-`, `*`, `/` and their wrapping/modulo behavior)
- Available assertion functions (`assert*`)
- Practical usage patterns combining these operations
- Error handling for values outside the valid field range (0 to 2^64 - 2^32 + 1)

## Impact

Developers following this guide to build Miden programs in Rust reach a gap at the point where they need to actually use `Felt` values in operations. The guide sets up the type but doesn't show how to work with it.

## Suggested Fix

Either:
1. Complete the section with examples of `Felt` arithmetic, assertions, and common patterns
2. Or link to the `miden-stdlib-sys` crate documentation / README where these operations may already be documented

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Il file da modificare è `versioned_docs/version-0.12/compiler/guides/develop_miden_in_rust.md`. Osserva il contenuto esistente intorno al tipo `Felt` e al segnaposto TODO. Esamina la documentazione o il codice sorgente della crate `miden-stdlib-sys` per comprendere le operazioni aritmetiche e le funzioni di asserzione disponibili. Aggiungi esempi chiari dell'uso di operazioni come `+`, `-`, `*`, `/` e funzioni come `assert*` su valori `Felt`. Assicurati che gli esempi siano compilabili e dimostrino modelli d'uso pratici. Fatto quando il TODO viene sostituito con una documentazione completa e utile.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
markdown, rust
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
70/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.