Skip to content

fix(docs): simplify TypeScript API reference links#22232

Merged
critesjosh merged 2 commits intonextfrom
jc/docs-fix-ts-api-ref-links
Apr 7, 2026
Merged

fix(docs): simplify TypeScript API reference links#22232
critesjosh merged 2 commits intonextfrom
jc/docs-fix-ts-api-ref-links

Conversation

@critesjosh
Copy link
Copy Markdown
Contributor

Summary

  • Remove dynamic version resolution components (ApiLink, ApiFile, ApiPath, useApiVersion) from typescript_api_reference.mdx in favor of static pathname:/// links that work correctly with the preprocessor
  • Update validation script to skip unresolved preprocessor macros (e.g., #api_ref_version in source files)
  • Applied across source docs and versioned copies (v4.1.0-rc.2, v4.2.0-aztecnr-rc.2)

Test plan

  • yarn build in docs/ succeeds
  • TypeScript API reference page renders correctly with working links
  • Validation script passes without false positives on preprocessor macros

… script

Remove dynamic version resolution components (ApiLink, ApiFile, ApiPath)
from typescript_api_reference.mdx in favor of static pathname:/// links
that work correctly with the preprocessor. Update the validation script
to skip unresolved preprocessor macros and fix a comment.
@critesjosh critesjosh requested a review from a team April 1, 2026 16:16
@critesjosh critesjosh marked this pull request as ready for review April 1, 2026 16:16
@critesjosh critesjosh added this pull request to the merge queue Apr 7, 2026
Merged via the queue into next with commit 45f88a8 Apr 7, 2026
19 of 20 checks passed
@critesjosh critesjosh deleted the jc/docs-fix-ts-api-ref-links branch April 7, 2026 15:34
@AztecBot
Copy link
Copy Markdown
Collaborator

AztecBot commented Apr 7, 2026

❌ Failed to cherry-pick to v4-next due to conflicts. (🤖) View backport run.

AztecBot pushed a commit that referenced this pull request Apr 7, 2026
AztecBot added a commit that referenced this pull request Apr 7, 2026
Resolved conflicts in both typescript_api_reference.mdx files by taking the
simplified CopyIcon component (removing dynamic useApiVersion, ApiLink, ApiPath
components) as intended by the original PR #22232.
critesjosh added a commit that referenced this pull request Apr 7, 2026
…22369)

## Summary
Backport of #22232
to v4-next.

- Removes dynamic version resolution components (`ApiLink`, `ApiFile`,
`ApiPath`, `useApiVersion`) from `typescript_api_reference.mdx` in favor
of static `pathname:///` links
- Simplifies `CopyIcon` component to take direct paths instead of
computing them from API version
- Updates validation script to skip unresolved preprocessor macros

## Cherry-pick conflicts
Conflicts occurred in both `typescript_api_reference.mdx` files (source
and v4.1.0-rc.2 versioned copy) because the v4-next branch had slightly
different `useApiVersion` implementations. Resolved by taking the
incoming simplified `CopyIcon` component and removing all dynamic
version components, matching the PR's intent.

## Commit structure
1. **Cherry-pick with conflicts** — original cherry-pick attempt with
conflict markers preserved
2. **Conflict resolution** — resolved by accepting the simplified
component definitions

ClaudeBox log: https://claudebox.work/s/363a65f4781acd9e?run=1
AztecBot added a commit that referenced this pull request Apr 7, 2026
Simplify TypeScript API reference links by removing dynamic JSX
components (useApiVersion, ApiLink, ApiFile, ApiPath) and replacing
with direct pathname:/// links pointing to testnet API docs folder.
AztecBot added a commit that referenced this pull request Apr 8, 2026
BEGIN_COMMIT_OVERRIDE
fix: pippenger edge case (#22256)
cherry-pick: fix: separate fisherman StatefulSet from rpc-node and stop
archiver pollution (#22183) — WITH CONFLICTS
fix: separate fisherman StatefulSet from rpc-node and stop archiver
pollution (backport #22183) (#22284)
fix: preserve DeployAccountMethod type in with() method chaining
(#22322)
docs: backport docs build/release infrastructure from #22106 and #22144
(#22223)
chore(docs): remove v5 nightly and devnet versioned docs (backport
#22193) (#22236)
chore: improve release-docs skill and add release-network-docs skill
(#22328)
chore: remove dead to_be_bytes fn (#22243)
fix: correct args length in `#[authorize_once]` (#22209)
chore: fix inconsistent usage of contract class hash fn (#22248)
chore: delete old field comparison fns in favor of lt (#22249)
fix: all account overrides + gas limits (#22173)
feat: allow for runtime length arrays of sorts and selects (#22250)
chore: remove dead pub global vars reexport (#22244)
chore: changed default wait behavior (#22325)
chore: apply code consistency consolidation (#22251)
fix(docs): simplify TypeScript API reference links (backport #22232)
(#22369)
fix: remove detailed revert codes (#22380)
fix: backport #21673 — prevent HA peer proposals from blocking
equivocation in duplicate proposal test (#21693)
fix: subfield note selectors (#22211)
END_COMMIT_OVERRIDE
critesjosh pushed a commit that referenced this pull request Apr 14, 2026
Simplify TypeScript API reference links by removing dynamic JSX
components (useApiVersion, ApiLink, ApiFile, ApiPath) and replacing
with direct pathname:/// links pointing to testnet API docs folder.
critesjosh added a commit that referenced this pull request Apr 16, 2026
Backport of #22366 to `v4-next`.

## Summary

Adds a "Getting Started on Testnet" guide and cross-links it from the
local network guide and the developer sidebar. Single commit, docs-only,
no code changes.

## Cherry-pick notes

`git cherry-pick -m 1 3b8d1f3` produced no conflict markers — only a
file-location warning because the PR added its versioned copy under
`docs/developer_versioned_docs/version-v4.2.0/` (the latest versioned
docs dir on `next`), and on this branch the equivalent directory is
`version-v4.1.0-rc.2/`. Git's rename detection mapped the new file to
the correct backport location; resolution was just `git add` +
`cherry-pick --continue`. This matches how prior backports (#22232,
#22193, etc.) have updated the v4.1.0-rc.2 versioned copies.

No conflict-resolution or build-fix commits were needed, so this is a
single clean commit rather than the 3-commit backport shape.

Analysis gist:
https://gist.github.com/AztecBot/1cc7e89de52ec1fdaef0b2194addf1af


ClaudeBox log: https://claudebox.work/s/90bb9caf79cca71d?run=1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants