Skip to content

docs(v5-next): backport counter tutorial alignment from #23517 - #24243

Merged
critesjosh merged 1 commit into
v5-nextfrom
cb/backport-23517-v5-next
Jun 23, 2026
Merged

docs(v5-next): backport counter tutorial alignment from #23517#24243
critesjosh merged 1 commit into
v5-nextfrom
cb/backport-23517-v5-next

Conversation

@AztecBot

Copy link
Copy Markdown
Collaborator

Backports the counter-tutorial half of #23517 (docs: align counter tutorial example with the aztec init template and add TXE tests, merged to next Jun 22) to v5-next.

Why this is the right scope

#23517's core intent was to align the counter tutorial example with what aztec init generates. On v5-next the scaffold template is already updated — yarn-project/aztec/scripts/templates/counter/contract/src/main.nr already defines fn constructor(initial_value: u128, ...). But the tutorial prose and the inlined example contract are still on the old initialize(headstart) naming, so the v5 tutorial currently contradicts the code aztec init produces. This backport closes that gap.

Files (2)

  • docs/docs-developers/docs/tutorials/contract_tutorials/counter_contract.mdinitializeconstructor, headstartinitial_value, intro reworded (encrypted private state), heading casing.
  • docs/examples/contracts/counter_contract/src/main.nr — same rename, so the tutorial's #include_code constructor block matches both the prose and the v5 scaffold template.

Deliberately excluded

  • TXE test harness (counter_contract_test, the docs/examples/bootstrap.sh test-contracts step, Nargo.toml member, logging_example_test tweak) — that's CI tooling, not docs, and counter_contract_test doesn't exist on v5-next.
  • Scaffold template — already correct on v5-next; no change needed.

Safety check

recursive_verification_contract also uses a headstart parameter, but it's an independent contract with its own constructor(headstart: Field, ...) (untouched by #23517 even on next), so the counter rename doesn't affect it.

Source PR: #23517. No tracked issue is closed by this backport.


Created by claudebox · group: slackbot

@AztecBot AztecBot added ci-draft Run CI on draft PRs. ci-no-fail-fast Sets NO_FAIL_FAST in the CI so the run is not aborted on the first failure claudebox Owned by claudebox. it can push to this PR. documentation labels Jun 23, 2026
@critesjosh
critesjosh marked this pull request as ready for review June 23, 2026 16:23
@critesjosh
critesjosh requested a review from a team as a code owner June 23, 2026 16:23
@critesjosh
critesjosh enabled auto-merge June 23, 2026 16:24
@critesjosh
critesjosh added this pull request to the merge queue Jun 23, 2026
Merged via the queue into v5-next with commit b35afa1 Jun 23, 2026
49 of 61 checks passed
@critesjosh
critesjosh deleted the cb/backport-23517-v5-next branch June 23, 2026 17:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci-draft Run CI on draft PRs. ci-no-fail-fast Sets NO_FAIL_FAST in the CI so the run is not aborted on the first failure claudebox Owned by claudebox. it can push to this PR. documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants