Skip to content

fix(docs): link tutorial examples in this repository at each line's commit - #25780

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

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

Conversation

@alejoamiras

Copy link
Copy Markdown
Contributor

The tutorials' links to their full example code pointed at a docs/examples folder in aztec-node that no longer exists. They now link the examples in this repository, at the commit the page was built from, so each docs version links its own code. A test fails if a hand-written examples link comes back, and the v6.0.0 support page's dead aztec-node link is repointed.

…examples

It renders the commit the page's snippet links into this repository name
(DOCS_COMMIT, else HEAD), so links and clones of docs/examples (or a
line's docs/lines/<line>/examples) show the files the page quotes. Like
those snippets, a release build without DOCS_COMMIT fails on a page that
uses it.
…e's line

aztec-node removed its docs/ in its #619, so the hand-written links into
aztec-node's docs/examples break at the next pin bump. Point them at this
repository's copy of the page's own line at #docs_commit, the commit the
page's snippets quote, and add a test that keeps such links out.
aztec-node has no docs/ since its #619; link this repository's
docs/docs-developers, as the dev copies of the page do.
A count over all roots passed while the v6 line's pathspec matched no
pages; check each root instead.
… disk

Fixed wildcard roots failed the scan once the last line was retired with
git rm -r docs/lines/<line>, which the docs support.
@alejoamiras
alejoamiras requested a review from a team as a code owner November 6, 2026 18:45
@alejoamiras
alejoamiras merged commit bddbc56 into next Nov 8, 2026
16 checks passed
@alejoamiras
alejoamiras deleted the worktree-docs-node-links branch November 8, 2026 12:18
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