docs: link to apiref, not gh, remove stale include code markers#22649
Merged
Conversation
nventuro
added
backport-to-v4-next
claudebox
nventuro
requested review from
critesjosh
and removed request for
a team and
LeilaWang
critesjosh
approved these changes
Apr 21, 2026
Collaborator
|
❌ Failed to cherry-pick to |
nventuro
added a commit
that referenced
this pull request
Apr 21, 2026
#22708) Backport of #22649 to v4-next. ## Original PR #22649 — "docs: link to apiref, not gh, remove stale include code markers" Swaps GitHub-file links for apiref pages and strips ~hundreds of `// docs:start:*` / `// docs:end:*` markers that no longer feed any `#include_code` macro (remnants of deleted tutorials). ## Cherry-pick conflicts The automatic cherry-pick produced 3 content conflicts and 37 modify/delete conflicts. Resolution follows `.claude/claudebox/backport.md`: commit 1 records the cherry-pick with conflict markers intact; commit 2 resolves them. **Content conflicts (3)** — upstream renamed `developer_versioned_docs/version-v4.1.0-rc.2/` → `version-v4.2.0/`; on v4-next only `v4.1.0-rc.2` exists, so the files stay at the original path but the body of each conflict takes the upstream (apiref) side: - `docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/aztec-nr/framework-description/advanced/protocol_oracles.md` - `docs/developer_versioned_docs/version-v4.1.0-rc.2/docs/aztec-nr/testing_contracts.md` - `docs/examples/ts/recursive_verification/index.ts` — kept `import assert from "node:assert"` (still used on line 118), dropped the stale `// docs:end:imports` marker. **Modify/delete conflicts (37)** — `docs/examples/webapp-tutorial/*` and `docs/examples/solidity/example_swap/*` were removed on v4-next but modified by #22649. Resolution: keep them deleted. ## Sanity check Grepped all `#include_code` references still live in `docs-developers/` and `developer_versioned_docs/` against the markers #22649 removed: every marker name that shows up in both lists still exists in the referenced source file after the backport, so no docs build should break. Docs-only change — no compile step, no third "build fixes" commit needed. ClaudeBox log: https://claudebox.work/s/3a184859f1383af3?run=1
dipkakwani
pushed a commit
to dipkakwani/aztec-packages
that referenced
this pull request
Apr 22, 2026
BEGIN_COMMIT_OVERRIDE fix(aztec): fail fast when nc is not installed in aztec test (AztecProtocol#22692) docs: link to apiref, not gh, remove stale include code markers (AztecProtocol#22649) END_COMMIT_OVERRIDE
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This fixes some links in the docsite that point to gh files to instead point to apiref pages. I also removed hundred of stale include code markers that are not being included anywhere - remnants of deleted tutorials.
I applied the link fixes to the 4.2.0 docs too.