Problem
The current node source docs are ingested into docs.miden.xyz under Core Concepts -> Node, but released version snapshots in the docs repo are checked in under versioned_docs/ and do not update automatically when the source node docs change.
The v0.14 node docs snapshot already appears stale in at least one network transaction area:
- current ingested node docs describe
GetNetworkNoteStatus,
versioned_docs/version-0.14/core-concepts/node/operator/architecture.md still refers to GetNoteError,
versioned_docs/version-0.14/core-concepts/node/rpc.md still documents GetNoteError,
GetNetworkNoteStatus is the current endpoint that returns lifecycle status, last error, attempt count, and last attempt block.
If the node docs are updated to clarify FPI behavior during network transaction execution, the same clarification should also be backported into the v0.14 versioned docs when it applies to v0.14.
Why this matters
Developers using versioned docs for v0.14 should not see stale network transaction debugging instructions. This is especially important for Pioneer teams debugging network notes, where the old feedback was that notes simply remained committed without useful error feedback.
Docs search and Docs AI may also surface versioned pages. If those pages still mention GetNoteError or omit the network transaction FPI behavior, users can get the wrong mental model even after the current docs are fixed.
Proposed scope
Patch the docs repo's v0.14 snapshot directly:
- update
versioned_docs/version-0.14/core-concepts/node/operator/architecture.md to reference GetNetworkNoteStatus,
- update
versioned_docs/version-0.14/core-concepts/node/rpc.md to document GetNetworkNoteStatus instead of GetNoteError,
- if the node source docs add a short section on FPI in network transactions, backport the same version-appropriate wording into the v0.14 node snapshot,
- avoid editing
docs/core-concepts/node/* directly unless it is generated from the node repo during the ingest workflow,
- cross-link the versioned node docs with the MASM/network-account tutorial work where appropriate.
Acceptance criteria
- v0.14 versioned node docs no longer refer users to the old
GetNoteError endpoint.
- v0.14 versioned node docs describe
GetNetworkNoteStatus fields accurately.
- Any FPI-in-network-transactions clarification added to node source docs is reflected in the v0.14 snapshot if the behavior exists in v0.14.
- Current docs and versioned docs do not contradict each other on network note diagnostics.
- The docs change is linked to the node source-doc/test work and the MASM network account tutorial issue.
Related context
- Pioneer feedback from Zoro via Domi.
0xMiden/node#1598
0xMiden/node#1758
0xMiden/node#1818
0xMiden/tutorials#193
- Local node draft:
issue-08-network-tx-fpi-runtime.md
Problem
The current node source docs are ingested into
docs.miden.xyzunder Core Concepts -> Node, but released version snapshots in the docs repo are checked in underversioned_docs/and do not update automatically when the source node docs change.The v0.14 node docs snapshot already appears stale in at least one network transaction area:
GetNetworkNoteStatus,versioned_docs/version-0.14/core-concepts/node/operator/architecture.mdstill refers toGetNoteError,versioned_docs/version-0.14/core-concepts/node/rpc.mdstill documentsGetNoteError,GetNetworkNoteStatusis the current endpoint that returns lifecycle status, last error, attempt count, and last attempt block.If the node docs are updated to clarify FPI behavior during network transaction execution, the same clarification should also be backported into the v0.14 versioned docs when it applies to v0.14.
Why this matters
Developers using versioned docs for v0.14 should not see stale network transaction debugging instructions. This is especially important for Pioneer teams debugging network notes, where the old feedback was that notes simply remained committed without useful error feedback.
Docs search and Docs AI may also surface versioned pages. If those pages still mention
GetNoteErroror omit the network transaction FPI behavior, users can get the wrong mental model even after the current docs are fixed.Proposed scope
Patch the docs repo's v0.14 snapshot directly:
versioned_docs/version-0.14/core-concepts/node/operator/architecture.mdto referenceGetNetworkNoteStatus,versioned_docs/version-0.14/core-concepts/node/rpc.mdto documentGetNetworkNoteStatusinstead ofGetNoteError,docs/core-concepts/node/*directly unless it is generated from the node repo during the ingest workflow,Acceptance criteria
GetNoteErrorendpoint.GetNetworkNoteStatusfields accurately.Related context
0xMiden/node#15980xMiden/node#17580xMiden/node#18180xMiden/tutorials#193issue-08-network-tx-fpi-runtime.md