You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[2026-10] Fix broken shopify.dev links in checkout API JSDoc - #4797
Old /apis/<name> links (and a couple of other stale URLs) render as 404s on
shopify.dev's checkout UI extensions reference. This repoints them to the current /target-apis/... URLs. Link targets only, no prose or type changes.
Anchors are rewritten to the new #docsstandard<api>api-propertydetail-<prop> ids, and #examples becomes #use-cases. The metafields property is no longer documented on this version, so that link goes to metafields-api#properties. Versionless links in address-autocomplete/standard.ts and preact/api.ts now use {API_VERSION}, like the rest of the surface. I checked each new URL on shopify.dev: every page loads, and every fragment exists as an element id on that version's page.
Generated docs: I changed only the links in the committed JSON. Each file is the base branch version with the same link rewrite as the source. A full rebuild on this branch also picks up large unrelated docs changes (source changes that were never regenerated). I did not include those, so this PR does not republish them. They need a separate, owner-reviewed regeneration.
Context: shopify.dev link audit for the checkout and customer account UI extensions
references. The shop/world side (MDX links and redirects) is handled in a separate
shopify-dev PR.
We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.
This PR targets a stable release branch (2026-10). Once merged, the change typically also needs to be forward-ported to 2027-01-rc so it ships in the next release.
When you open the forward-port PR, include a line like this in its body so the needs-rc-port label gets removed automatically when that PR merges:
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
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.
Old
/apis/<name>links (and a couple of other stale URLs) render as 404s onshopify.dev's checkout UI extensions reference. This repoints them to the current
/target-apis/...URLs. Link targets only, no prose or type changes.Target branch:
2026-10(this PR only) Links fixed: 27 Files:ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts,ui-extensions/src/surfaces/checkout/api/checkout/checkout.ts,ui-extensions/src/surfaces/checkout/api/standard/standard.ts,ui-extensions/src/surfaces/checkout/preact/api.tsSibling PRs for the other versions: #4798 (
2027-01-rc), #4799 (2026-07), #4800 (2026-04), #4801 (2026-01), #4802 (2025-10), #4803 (2025-07), #4804 (2026-10-rc), #4805 (unstable)Unresolved: none
Anchors are rewritten to the new
#docsstandard<api>api-propertydetail-<prop>ids, and#examplesbecomes#use-cases. Themetafieldsproperty is no longer documented on this version, so that link goes tometafields-api#properties. Versionless links inaddress-autocomplete/standard.tsandpreact/api.tsnow use{API_VERSION}, like the rest of the surface. I checked each new URL on shopify.dev: every page loads, and every fragment exists as an element id on that version's page.Generated docs: I changed only the links in the committed JSON. Each file is the base branch version with the same link rewrite as the source. A full rebuild on this branch also picks up large unrelated docs changes (source changes that were never regenerated). I did not include those, so this PR does not republish them. They need a separate, owner-reviewed regeneration.
Context: shopify.dev link audit for the checkout and customer account UI extensions
references. The shop/world side (MDX links and redirects) is handled in a separate
shopify-dev PR.
🤖 Generated with Claude Code