Skip to content

[2026-10] Fix broken shopify.dev links in checkout API JSDoc - #4797

Open
laurelthorburn wants to merge 3 commits into
2026-10from
2026-10-fix-checkout-api-links
Open

laurelthorburn wants to merge 3 commits into
2026-10from
2026-10-fix-checkout-api-links

Conversation

@laurelthorburn

@laurelthorburn laurelthorburn commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

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.

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.ts
Sibling 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 #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.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

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.

@github-actions github-actions Bot added the needs-rc-port PR against a stable branch awaiting forward-port to the current RC label Nov 9, 2026
@github-actions

github-actions Bot commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

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:

Forward-port of #4797

Accepted formats (comma-separated for multiple):

  • #4797
  • GH-4797
  • 4797
  • https://github.com/Shopify/ui-extensions/pull/4797

If a forward-port isn't needed (e.g., the change is stable-only), you can remove the needs-rc-port label manually.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-rc-port PR against a stable branch awaiting forward-port to the current RC shopify.dev preview

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant