Skip to content

docs: adapt the docs tooling to aztec-node's main and v6 branches - #25734

Merged
alejoamiras merged 5 commits into
nextfrom
worktree-docs-node-branches
Nov 5, 2026
Merged

alejoamiras merged 5 commits into
nextfrom
worktree-docs-node-branches

Conversation

@alejoamiras

@alejoamiras alejoamiras commented Nov 2, 2026 •

Copy link
Copy Markdown
Contributor

Summary

aztec-node now carries v7 on main and v6 on a new v6 branch, with backports made by hand. Until the docs can carry both lines, the dev docs stay on v6 nightlies, because a v6.x release is cut from them. This PR updates the docs tooling text and the four docs skills for that layout. It also fixes the version macros, which pointed at an aztec-node ref that does not exist.

The pin script needs no change, since its tag pattern accepts v7 tags. The pin itself does not move here.

Before merge

  • main's first nightly is v7.0.0-nightly.20261105, which matches the example on the networks page.
  • A dry run of pinning v7.0.0-nightly.20261105 on a copy of the pin passed. The committed pin is untouched.
  • The branch is rebased onto next, and the docs checks pass on it.

Changes

  • Dev pin policy: the dev pin stays on the newest v6 nightly, never a v7 tag, until the docs carry a separate v7 line. A one-line check confirms that the pinned commit is on v6.
  • Version macro default: without a release tag set, the legacy Labs version macros now name the pinned tag instead of next and latest. This fixes 38 dead aztec-node links and the aztec-nr tags in previews and local builds. Release cuts are unchanged.
  • Foundation package versions: three Foundation package installs in two tutorials now use the Foundation version, not the Labs version.
  • release-docs:
    • Migration-note triage also covers the Unreleased sections and handles hand backports.
    • The content check expects adapted backports on both sides.
    • The cut stops if the dev pin is ever a v7 tag.
  • release-network-docs: the same note on adapted backports.
  • update-doc-references: an aztec-node PR into main (v7) whose merge commit is not in the pin is analyzed and reported, and gets no source edits.
  • updating-changelog: for a single aztec-node PR, the skill takes the major version from the PR's base branch.
  • Pages:
    • The networks page's nightly row names main and 7.0.0-nightly.<date>.
    • The support page's source link points at this repository instead of a missing aztec-node branch.

Not in this PR

  • Three Nargo dependencies on aztec-packages that use the Labs version macro stay broken. The paths they name no longer exist here, so no tag can fix them.
  • Two dev lines, with v6 and v7 side by side, are planned separately. The dev pin moves to v7 only after that work lands.
  • Labs hasn't confirmed which branch the v6 nightlies come from. Today's sits where v6 left main, so the pin check holds either way. The networks page doesn't mention v6 nightlies.

Test plan

  • Docs unit tests: 147 pass, 1 env-gated skip.
  • Script tests with no node_modules: 45 pass, 1 skip.
  • ./bootstrap.sh check: the skills lint, the reference check, and the netlify and warnings checks all pass.
  • New macro test: with no release tag set, both legacy macros give the pinned ref, and the release version still follows the nightly tag. It failed before the fix and passes after.
  • cspell finds no new words on the touched pages and lines.
  • Pin dry run of v7.0.0-nightly.20261105 on a copy of the pin: fetched, all four noir archives attested, and the toolchain unchanged (bb 6.0.0-rc.7, noir 1.0.0-rc.3).
  • The documented v6 check prints behind for the current pin.
  • Rendered the three affected tutorial pages without a release tag. Labs packages and aztec-nr tags show the pinned nightly, Foundation packages show the pinned bb version, and the aztec-node link targets exist at the tag.

Without COMMIT_TAG (previews, local builds) the legacy macros resolved to next and latest. aztec-node has no next ref, so 38 source links and the aztec-nr Nargo tags pointed nowhere. They now take the ref docs/aztec-node.json pins. Release cuts set COMMIT_TAG and are unchanged.

Three @aztec-foundation installs used the Labs macro and named the Labs version in every build; they now use #include_foundation_version_without_prefix.
From 2026-11-04 aztec-node carries v7 on main and v6 on a v6 branch, with hand backports. The dev pin moves to the newest nightly of main's major and is checked to be on main; release cuts pin their tag. The release skills now find hand backports in migration-note triage (TBD and Unreleased) and expect adapted backports on both sides of the content check. update-doc-references reports, without editing, v6 PRs the pin lacks; updating-changelog takes a PR's major from its base. networks.md and support.md no longer name a development branch or aztec-node's nonexistent next.
…rry a v7 line

A v6.x release is cut from the dev docs' pages and examples, so it works
only while they are v6 content. The pin check now tests that the recorded
commit is on v6, and update-doc-references gates PRs into main (v7)
instead of PRs into v6.
@alejoamiras alejoamiras changed the title docs: follow aztec-node main for dev docs after the v6 branch split docs: adapt the docs tooling to aztec-node's main and v6 branches Nov 5, 2026
@alejoamiras
alejoamiras marked this pull request as ready for review November 5, 2026 14:57
@alejoamiras
alejoamiras requested a review from a team as a code owner November 5, 2026 14:57
@alejoamiras
alejoamiras merged commit 53a8ed9 into next Nov 5, 2026
21 checks passed
@alejoamiras
alejoamiras deleted the worktree-docs-node-branches branch November 5, 2026 19:45
alejoamiras added a commit that referenced this pull request Nov 5, 2026
The docs tooling learns about dev lines: a copy of the dev docs under
`docs/lines/<line>/` that follows one aztec-node branch with its own
pin. This PR adds no line, so the site, CI and Netlify behave as before.
The next PR adds the v6 line.

Stacked on #25734.

- Adds a fingerprint of what a production build serves, so every PR can
show that production is unchanged.
- The aztec-node pin tool fetches, pins and provisions a line on its
own, with its own contracts package, and refuses a tag from another
major.
- Pages in a line take their code snippets, versions and links from that
line.
- A page that quotes the other line's examples or contracts fails the
build.
- A line's examples build outside the repository, and its references are
checked against its own code. Main's examples build as before.

Tests:
- New unit tests cover each of these.
- The script tests pass without installed packages.
- The production fingerprint is identical before and after.
- The line tooling passes against a temporary v6 copy.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants