Remove dangling buyer-journey #examples link from buyerJourney JSDoc (2026-01)#4523
Merged
Merged
Conversation
The buyerJourney property's JSDoc pointed at
/docs/api/checkout-ui-extensions/.../apis/buyer-journey#examples, which 404s
under /latest. The docs were reorganized from apis/<name> to
target-apis/checkout-apis/<name>-api, and the #examples anchor no longer
exists (examples now render via the example switcher). This removes the
self-referential statement, mirroring World commit 80249b ("Remove
self-referential link in buyerJourney prop JSDoc").
Source-only change: the committed
docs/surfaces/checkout/generated/generated_docs_data_v2.json artifact still
needs to be regenerated via `pnpm docs:checkout` for the rendered shopify.dev
page to update.
Reported-by: Kristin Hung <kristin.hung@shopify.com>
Contributor
|
We detected some changes in |
reykjalin
approved these changes
Jun 23, 2026
reykjalin
left a comment
reykjalin
left a comment
There was a problem hiding this comment.
source changes look good. I didn't look through the newly generated data, but assume it's good.
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.
Background
A merchant-facing dev docs page was reported broken in this Slack thread: https://shopify.dev/docs/api/checkout-ui-extensions/latest/apis/buyer-journey#examples returns a 404.
The root cause is a self-referential statement in the
buyerJourneyproperty's JSDoc inpackages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts:That link is broken two ways: the
#examplesanchor no longer exists (examples now render via<ExampleSwitcher>at the top of the page), andapis/buyer-journeyis the pre-reorg path (docs were reorganized totarget-apis/checkout-apis/buyer-journey-api), so it 404s under/latest.This was already removed at HEAD in World (
checkout-web/packages/ui-extensions) in commit80249b("Remove self-referential link in buyerJourney prop JSDoc"), but that has not propagated to the published2026-01version snapshot, which shopify.dev syncs from this branch.One of a set of per-version PRs (one per affected release branch:
2025-07,2025-10,2026-01,2026-04,2026-07-rc).Solution
Remove the dangling statement from the
buyerJourneyJSDoc on the2026-01branch, mirroring World commit80249b.docs/surfaces/checkout/generated/generated_docs_data_v2.jsonis regenerated viapnpm docs:checkout(docs/surfaces/checkout/build-docs.sh) and committed, then picked up by shopify.dev's once-a-day sync. That regen step is intentionally not included here — flagging for a maintainer to run before/at merge.Patch authored by River; reported by Kristin Hung.
🎩
80249band thatgit apply --checkis clean on this branch.Checklist