0xMiden / 0xMiden/docs

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

Aberta
#163 1 comentário 0 reações 0 responsáveis Ver no GitHub
Linguagem predominante
TypeScript
Estrelas
10
Forks
50
Merge médio
22d 23h
PRs com merge (30d)
1

Descrição

## 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

Guia de contribuição

Abrir o guia de contribuição

Avaliação

Esta issue ainda não foi avaliada.

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.