Skip to content

Commit cebd2d1

Browse files
authored
Merge pull request #4311 from Shopify/fix/ca-broken-links-2025-10
Fix broken and incorrect documentation links across CA pages (2025-10)
2 parents 2a8156c + 941681e commit cebd2d1

8 files changed

Lines changed: 12 additions & 13 deletions

File tree

packages/ui-extensions/src/surfaces/checkout/api/address-autocomplete/standard.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ export interface AddressAutocompleteStandardApi<
123123
*
124124
* If the previous token expires, this value will reflect a new session token with a new signature and expiry.
125125
*
126-
* Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information.
126+
* Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).
127127
*/
128128
sessionToken: SessionToken;
129129

packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -740,7 +740,7 @@ export interface StandardApi<Target extends ExtensionTarget = ExtensionTarget> {
740740
*
741741
* If the previous token expires, this value reflects a new session token with a new signature and expiry.
742742
*
743-
* Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/apis/session-token) for more information.
743+
* Learn more about [session tokens](/docs/apps/build/authentication-authorization/session-tokens).
744744
*/
745745
sessionToken: SessionToken;
746746

packages/ui-extensions/src/surfaces/checkout/components/components-shared.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -953,7 +953,7 @@ export type AccessibilityRole =
953953
* Used to indicate the component is a header.
954954
*
955955
* In an HTML host `header` will render a `<header>` element.
956-
* Learn more about the [`<header>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/main_role) in the MDN web docs.
956+
* Learn more about the [`<header>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/header) and its [implicit role](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/banner_role) in the MDN web docs.
957957
*/
958958
| "header"
959959
/**

packages/ui-extensions/src/surfaces/customer-account/api/order-status/order-status.ts

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,7 @@ export interface OrderStatusApi<Target extends ExtensionTarget> {
233233

234234
/**
235235
* The [metafields](/docs/apps/build/custom-data/metafields) requested in the
236-
* [`shopify.extension.toml`](/docs/api/customer-account-ui-extensions/latest#configuration)
236+
* [`shopify.extension.toml`](/docs/apps/build/customer-accounts/metafields#create-the-metafield-definition)
237237
* file. Metafields are custom data fields that store additional information on Shopify resources
238238
* such as products, variants, customers, and the shop. These metafields are updated when there's
239239
* a change in the merchandise items being purchased by the customer.
@@ -306,7 +306,7 @@ export interface OrderStatusApi<Target extends ExtensionTarget> {
306306
/**
307307
* The buyer's locale, currency, time zone, country, and market context for the order.
308308
* Use these values to adapt your extension's content to the buyer's region. For formatted
309-
* dates, numbers, and translated strings, use the [Localization API](/docs/api/customer-account-ui-extensions/target-apis/platform-apis/localization-api)
309+
* dates, numbers, and translated strings, use the [Localization API](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/platform-apis/localization-api)
310310
* instead.
311311
*/
312312
localization: OrderStatusLocalization;
@@ -332,8 +332,7 @@ export interface OrderStatusApi<Target extends ExtensionTarget> {
332332
/**
333333
* The token that identifies the checkout session used to create the order. Use this value
334334
* to correlate the order with analytics events or backend API calls. This matches the
335-
* `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout)
336-
* and the `checkout_token` field in the [Admin REST API Order resource](/docs/api/admin-rest/unstable/resources/order#resource-object).
335+
* `token` field in the [WebPixel checkout payload](/docs/api/pixels/customer-events#checkout).
337336
* The value is `undefined` if the checkout token is unavailable.
338337
*/
339338
checkoutToken: SubscribableSignalLike<CheckoutToken | undefined>;
@@ -781,7 +780,7 @@ export interface SelectedPaymentOption {
781780
/**
782781
* The handle of the payment option the buyer selected, corresponding to a `PaymentOption.handle` value.
783782
*
784-
* See [availablePaymentOptions](/docs/api/checkout-ui-extensions/apis/payments#standardapi-propertydetail-selectedpaymentoptions).
783+
* See [availablePaymentOptions](/docs/api/customer-account-ui-extensions/{API_VERSION}/target-apis/order-apis/payments-api).
785784
*/
786785
handle: string;
787786
}
@@ -957,7 +956,7 @@ export interface PaymentTermsTemplate {
957956
*/
958957
id: string;
959958
/**
960-
* The name of the payment terms translated to the buyer's current language, such as "Net 30" or "Due on receipt". See [localization.language](/docs/api/customer-account-ui-extensions/apis/localization#standardapi-propertydetail-localization).
959+
* The name of the payment terms translated to the buyer's current language, such as "Net 30" or "Due on receipt". See [localization.language](/docs/api/customer-account-ui-extensions/{API_VERSION}/apis/localization#standardapi-propertydetail-localization).
961960
*/
962961
name: string;
963962
/**

packages/ui-extensions/src/surfaces/customer-account/components/Avatar/Avatar.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ const data: ReferenceEntityTemplateSchema = {
1717
{
1818
title: 'Events',
1919
description:
20-
'Learn more about [registering events](/docs/api/customer-account-ui-extensions/using-web-components#handling-events).',
20+
'Learn more about [handling events](/docs/api/customer-account-ui-extensions/{API_VERSION}/using-web-components#handling-events).',
2121
type: 'AvatarEventsDocs',
2222
},
2323
],

packages/ui-extensions/src/surfaces/customer-account/components/ButtonGroup/ButtonGroup.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ const data: ReferenceEntityTemplateSchema = {
44
name: 'Button group',
55
description: `ButtonGroup is used to display multiple buttons in a layout that is contextual based on the screen width or parent component. When there is more than one secondary action, they get collapsed.
66
7-
When used within a [Section](/docs/api/customer-account-ui-extensions/web-components/structure/section) component, the buttons will fill the width of the section.
7+
When used within a [Section](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/structure/section) component, the buttons will fill the width of the section.
88
`,
99
thumbnail: 'buttongroup-thumbnail.png',
1010
requires: '',

packages/ui-extensions/src/surfaces/customer-account/components/CustomerAccountAction/CustomerAccountAction.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
33
const data: ReferenceEntityTemplateSchema = {
44
name: 'Customer account action',
55
description:
6-
'A modal to complete an order action flow. This component can only be used to populate the [customer-account.order.action.render](/docs/api/customer-account-ui-extensions/unstable/targets/order-action-menu/customer-account-order-action-render) extension target, which renders as a result of the customer clicking the order action button rendered via the [customer-account.order.action.menu-item.render](/docs/api/customer-account-ui-extensions/unstable/targets/order-action-menu/customer-account-order-action-menu-item-render) extension target.',
6+
'A modal to complete an order action flow. This component can only be used to populate the [customer-account.order.action.render](/docs/api/customer-account-ui-extensions/{API_VERSION}/targets/order-action-menu/customer-account-order-action-render) extension target, which renders as a result of the customer clicking the order action button rendered via the [customer-account.order.action.menu-item.render](/docs/api/customer-account-ui-extensions/{API_VERSION}/targets/order-action-menu/customer-account-order-action-menu-item-render) extension target.',
77
thumbnail: 'customeraccountaction-thumbnail.png',
88
requires: '',
99
isVisualComponent: true,

packages/ui-extensions/src/surfaces/customer-account/components/ImageGroup/ImageGroup.doc.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
33
const data: ReferenceEntityTemplateSchema = {
44
name: 'Image group',
55
description:
6-
'Display up to 4 images in a grid or stacked layout. The images are displayed as a grid when used within a [Section](/docs/api/customer-account-ui-extensions/web-components/structure/section) component. For example, images of products in a wishlist or subscription. When there are more than 4 images, the component indicates how many more images are not displayed.',
6+
'Display up to 4 images in a grid or stacked layout. The images are displayed as a grid when used within a [Section](/docs/api/customer-account-ui-extensions/{API_VERSION}/web-components/structure/section) component. For example, images of products in a wishlist or subscription. When there are more than 4 images, the component indicates how many more images are not displayed.',
77
thumbnail: 'imagegroup-thumbnail.png',
88
requires: '',
99
isVisualComponent: true,

0 commit comments

Comments
 (0)