0xMiden/miden-vm

docs: document `word("...")` string constructor for word constants

Open

#2,687 opened on Feb 13, 2026

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Rust (303 forks)github user discovery
documentationgood first issue

Repository metrics

Stars
 (753 stars)
PR merge metrics
 (Avg merge 6d 2h) (71 merged PRs in 30d)

Description

Summary

The word("...") syntax for deriving a Word constant from a string hash is widely used (especially for named storage slot IDs) but is not documented in the assembly reference.

Details

The code organization docs document word constants declared as arrays ([1,2,3,4]) and hex values, but not the word("string") constructor.

This constructor is used extensively in miden-base and tutorials, e.g.:

const METADATA_SLOT = word("miden::standards::fungible_faucets::metadata")
push.METADATA_SLOT[0..2]
exec.active_account::get_item

Suggestion

Add a subsection to the "Word constants" section in docs/src/user_docs/assembly/code_organization.md explaining:

  • The word("string") syntax and what it computes (deterministic Word from string hash)
  • Common use case: named storage slot IDs with [0..2] slice notation

Contributor guide

Research direction
Review the existing word constants documentation at docs/src/user docs/assembly/code organization.md, find the section on word constants, and add a subsection explaining the word("...") constructor with its use case for named storage slots. Check the codebase for examples of this syntax to illustrate accurately.
Tech stack
rust
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80