diff --git a/packages/ui-extensions/src/docs/shared/components/Avatar.ts b/packages/ui-extensions/src/docs/shared/components/Avatar.ts index 2b415ce9a9..6ccd0af4c6 100644 --- a/packages/ui-extensions/src/docs/shared/components/Avatar.ts +++ b/packages/ui-extensions/src/docs/shared/components/Avatar.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Show a user’s profile image or initials in a compact, visual element.', category: 'Polaris web components', - subCategory: 'Media', + subCategory: 'Media and visuals', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Badge.ts b/packages/ui-extensions/src/docs/shared/components/Badge.ts index 9e97519953..cb5a5f7983 100644 --- a/packages/ui-extensions/src/docs/shared/components/Badge.ts +++ b/packages/ui-extensions/src/docs/shared/components/Badge.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Inform users about the status of an object or indicate that an action has been completed.', category: 'Polaris web components', - subCategory: 'Titles and text', + subCategory: 'Feedback and status indicators', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Banner.ts b/packages/ui-extensions/src/docs/shared/components/Banner.ts index 934642fabe..49d765c330 100644 --- a/packages/ui-extensions/src/docs/shared/components/Banner.ts +++ b/packages/ui-extensions/src/docs/shared/components/Banner.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Highlights important information or required actions prominently within the interface. Use to communicate statuses, provide feedback, or draw attention to critical updates.', category: 'Polaris web components', - subCategory: 'Feedback', + subCategory: 'Feedback and status indicators', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Box.ts b/packages/ui-extensions/src/docs/shared/components/Box.ts index 3ee5bc42da..2c61bc8060 100644 --- a/packages/ui-extensions/src/docs/shared/components/Box.ts +++ b/packages/ui-extensions/src/docs/shared/components/Box.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'A generic container that provides a flexible alternative for custom designs not achievable with existing components. Use it to apply styling such as backgrounds, padding, or borders, or to nest and group other components. The contents of Box always maintain their natural size, making it especially useful within layout components that would otherwise stretch their children.', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Chip.ts b/packages/ui-extensions/src/docs/shared/components/Chip.ts index 98c7123d5c..a3940e878b 100644 --- a/packages/ui-extensions/src/docs/shared/components/Chip.ts +++ b/packages/ui-extensions/src/docs/shared/components/Chip.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Represents a set of user-supplied keywords that help label, organize, and categorize objects. Used to categorize or highlight content attributes. They are often displayed near the content they classify, enhancing discoverability by allowing users to identify items with similar properties.', category: 'Polaris web components', - subCategory: 'Titles and text', + subCategory: 'Typography and content', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Divider.ts b/packages/ui-extensions/src/docs/shared/components/Divider.ts index 39793b3c9a..d63a402c23 100644 --- a/packages/ui-extensions/src/docs/shared/components/Divider.ts +++ b/packages/ui-extensions/src/docs/shared/components/Divider.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Create clear visual separation between elements in your user interface.', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Grid.ts b/packages/ui-extensions/src/docs/shared/components/Grid.ts index 4c9ac58f39..9cb9cbf27a 100644 --- a/packages/ui-extensions/src/docs/shared/components/Grid.ts +++ b/packages/ui-extensions/src/docs/shared/components/Grid.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Use `s-grid` to organize your content in a matrix of rows and columns and make responsive layouts for pages. Grid follows the same pattern as the [CSS grid layout](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_grid_layout).', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Heading.ts b/packages/ui-extensions/src/docs/shared/components/Heading.ts index 868c9704c5..c28ba29045 100644 --- a/packages/ui-extensions/src/docs/shared/components/Heading.ts +++ b/packages/ui-extensions/src/docs/shared/components/Heading.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Renders hierarchical titles to communicate the structure and organization of page content. Heading levels adjust automatically based on nesting within parent Section components, ensuring a meaningful and accessible page outline.', category: 'Polaris web components', - subCategory: 'Titles and text', + subCategory: 'Typography and content', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Icon.ts b/packages/ui-extensions/src/docs/shared/components/Icon.ts index 22601feeb8..ad91d5acda 100644 --- a/packages/ui-extensions/src/docs/shared/components/Icon.ts +++ b/packages/ui-extensions/src/docs/shared/components/Icon.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Renders a graphic symbol to visually communicate core parts of the product and available actions. Icons can act as wayfinding tools to help users quickly understand their location within the interface and common interaction patterns.', category: 'Polaris web components', - subCategory: 'Media', + subCategory: 'Media and visuals', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Image.ts b/packages/ui-extensions/src/docs/shared/components/Image.ts index 1614ce082a..09dcc9843a 100644 --- a/packages/ui-extensions/src/docs/shared/components/Image.ts +++ b/packages/ui-extensions/src/docs/shared/components/Image.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Embeds an image within the interface and controls its presentation. Use to visually illustrate concepts, showcase products, or support user tasks and interactions.', category: 'Polaris web components', - subCategory: 'Media', + subCategory: 'Media and visuals', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/OrderedList.ts b/packages/ui-extensions/src/docs/shared/components/OrderedList.ts index cbff86a5a9..4674166449 100644 --- a/packages/ui-extensions/src/docs/shared/components/OrderedList.ts +++ b/packages/ui-extensions/src/docs/shared/components/OrderedList.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Displays a numbered list of related items in a specific sequence. Use to present step-by-step instructions, ranked items, or procedures where order matters.', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Paragraph.ts b/packages/ui-extensions/src/docs/shared/components/Paragraph.ts index 971c072293..fffe3321a6 100644 --- a/packages/ui-extensions/src/docs/shared/components/Paragraph.ts +++ b/packages/ui-extensions/src/docs/shared/components/Paragraph.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Displays a block of text and can contain inline elements such as buttons, links, or emphasized text. Use to present standalone blocks of content as opposed to inline text.', category: 'Polaris web components', - subCategory: 'Titles and text', + subCategory: 'Typography and content', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/QueryContainer.ts b/packages/ui-extensions/src/docs/shared/components/QueryContainer.ts index e061b9976d..9357a56a98 100644 --- a/packages/ui-extensions/src/docs/shared/components/QueryContainer.ts +++ b/packages/ui-extensions/src/docs/shared/components/QueryContainer.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Establishes a query container for responsive design. Use `s-query-container` to define an element as a containment context, enabling child components or styles to adapt based on the container’s size.', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Section.ts b/packages/ui-extensions/src/docs/shared/components/Section.ts index afface694f..e2b858defe 100644 --- a/packages/ui-extensions/src/docs/shared/components/Section.ts +++ b/packages/ui-extensions/src/docs/shared/components/Section.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Groups related content into clearly-defined thematic areas. Sections have contextual styling that automatically adapts based on nesting depth. They also adjust heading levels to maintain a meaningful and accessible page structure.', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Spinner.ts b/packages/ui-extensions/src/docs/shared/components/Spinner.ts index 45612c7cc1..f99270884f 100644 --- a/packages/ui-extensions/src/docs/shared/components/Spinner.ts +++ b/packages/ui-extensions/src/docs/shared/components/Spinner.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Displays an animated indicator showing users that content or actions are loading. Use to communicate ongoing processes, such as fetching data from a server. For loading states on buttons, use the “loading” property on the Button component instead.', category: 'Polaris web components', - subCategory: 'Feedback', + subCategory: 'Feedback and status indicators', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Stack.ts b/packages/ui-extensions/src/docs/shared/components/Stack.ts index 65984ba5e7..b3837f0ce3 100644 --- a/packages/ui-extensions/src/docs/shared/components/Stack.ts +++ b/packages/ui-extensions/src/docs/shared/components/Stack.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Organizes elements horizontally or vertically along the block or inline axis. Use to structure layouts, group related components, or control spacing between elements.', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Table.ts b/packages/ui-extensions/src/docs/shared/components/Table.ts index a7eed93080..f68efcb3e2 100644 --- a/packages/ui-extensions/src/docs/shared/components/Table.ts +++ b/packages/ui-extensions/src/docs/shared/components/Table.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Display data clearly in rows and columns, helping users view, analyze, and compare information. Automatically renders as a list on small screens and a table on large ones.', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Text.ts b/packages/ui-extensions/src/docs/shared/components/Text.ts index c9a7fcb0fb..79b459d73a 100644 --- a/packages/ui-extensions/src/docs/shared/components/Text.ts +++ b/packages/ui-extensions/src/docs/shared/components/Text.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Displays inline text with specific visual styles or tones. Use to emphasize or differentiate words or phrases within a Paragraph or other block-level components.', category: 'Polaris web components', - subCategory: 'Titles and text', + subCategory: 'Typography and content', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Thumbnail.ts b/packages/ui-extensions/src/docs/shared/components/Thumbnail.ts index 8da9db0aaa..da904e08b2 100644 --- a/packages/ui-extensions/src/docs/shared/components/Thumbnail.ts +++ b/packages/ui-extensions/src/docs/shared/components/Thumbnail.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Display a small preview image representing content, products, or media.', category: 'Polaris web components', - subCategory: 'Media', + subCategory: 'Media and visuals', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/Tooltip.ts b/packages/ui-extensions/src/docs/shared/components/Tooltip.ts index 3f74e8c052..18b4c5d320 100644 --- a/packages/ui-extensions/src/docs/shared/components/Tooltip.ts +++ b/packages/ui-extensions/src/docs/shared/components/Tooltip.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Displays helpful information in a small overlay when users hover or focus on an element. Use to provide additional context without cluttering the interface.', category: 'Polaris web components', - subCategory: 'Overlays', + subCategory: 'Typography and content', related: [], }; diff --git a/packages/ui-extensions/src/docs/shared/components/UnorderedList.ts b/packages/ui-extensions/src/docs/shared/components/UnorderedList.ts index 867ce07103..d58475b0ad 100644 --- a/packages/ui-extensions/src/docs/shared/components/UnorderedList.ts +++ b/packages/ui-extensions/src/docs/shared/components/UnorderedList.ts @@ -5,7 +5,7 @@ const data: SharedReferenceEntityTemplateSchema = { description: 'Displays a bulleted list of related items. Use to present collections of items or options where the sequence isn’t critical.', category: 'Polaris web components', - subCategory: 'Structure', + subCategory: 'Layout and structure', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/api/action/action.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/action/action.doc.ts index 7a612e6b3b..5a17bef384 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/action/action.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/action/action.doc.ts @@ -13,8 +13,8 @@ const data: ReferenceEntityTemplateSchema = { type: 'ActionExtensionApi', }, ], - category: 'API', - subCategory: 'Target APIs', + category: 'Target APIs', + subCategory: 'Core APIs', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/api/block/block.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/block/block.doc.ts index 40a784b867..11bc07fd0b 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/block/block.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/block/block.doc.ts @@ -13,8 +13,8 @@ const data: ReferenceEntityTemplateSchema = { type: 'BlockExtensionApi', }, ], - category: 'API', - subCategory: 'Target APIs', + category: 'Target APIs', + subCategory: 'Core APIs', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/api/checkout-rules/validation-settings.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/checkout-rules/validation-settings.doc.ts index 2078a8f198..395508cba9 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/checkout-rules/validation-settings.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/checkout-rules/validation-settings.doc.ts @@ -18,8 +18,8 @@ const data: ReferenceEntityTemplateSchema = { type: 'ValidationData', }, ], - category: 'API', - subCategory: 'Target APIs', + category: 'Target APIs', + subCategory: 'Contextual APIs', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/api/customer-segment-template/customer-segment-template.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/customer-segment-template/customer-segment-template.doc.ts index c958deeffe..49e7fe6a92 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/customer-segment-template/customer-segment-template.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/customer-segment-template/customer-segment-template.doc.ts @@ -1,7 +1,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; const data: ReferenceEntityTemplateSchema = { - name: 'CustomerSegmentTemplate Extension API', + name: 'Customer Segment Template Extension API', description: 'This API is available to all customer segment template extension types.', isVisualComponent: false, @@ -13,8 +13,8 @@ const data: ReferenceEntityTemplateSchema = { type: 'CustomerSegmentTemplateApi', }, ], - category: 'API', - subCategory: 'Target APIs', + category: 'Target APIs', + subCategory: 'Contextual APIs', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/api/discount-function-settings/discount-function-settings.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/discount-function-settings/discount-function-settings.doc.ts index 4c2c8ec44e..921f6ebc2a 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/discount-function-settings/discount-function-settings.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/discount-function-settings/discount-function-settings.doc.ts @@ -19,8 +19,8 @@ const data: ReferenceEntityTemplateSchema = { type: 'DiscountFunctionSettingsData', }, ], - category: 'API', - subCategory: 'Target APIs', + category: 'Target APIs', + subCategory: 'Contextual APIs', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/api/intents/intents.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/intents/intents.doc.ts index 89fd878f88..dd6ffcb6b2 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/intents/intents.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/intents/intents.doc.ts @@ -1,12 +1,13 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Intents', + name: 'Intents API', overviewPreviewDescription: 'Orchestrate workflows and operations across Shopify resources', description: `The Intents API provides a way to invoke existing admin workflows for creating, editing, and managing Shopify resources.`, isVisualComponent: true, - category: 'API', + category: 'Target APIs', + subCategory: 'Utility APIs', thumbnail: 'intents.png', requires: 'an Admin [block](/docs/api/admin-extensions/unstable/extension-targets#block-locations) or [action](/docs/api/admin-extensions/unstable/extension-targets#action-locations) extension.', diff --git a/packages/ui-extensions/src/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.ts new file mode 100644 index 0000000000..b23ccb869a --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/api/order-routing-rule/order-routing-rule.doc.ts @@ -0,0 +1,21 @@ +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; + +const data: ReferenceEntityTemplateSchema = { + name: 'Order Routing Rule API', + description: + 'This API is available to extensions that render in the order routing settings using the `admin.settings.order-routing-rule.render` target.', + isVisualComponent: false, + type: 'API', + definitions: [ + { + title: 'OrderRoutingRuleApi', + description: '', + type: 'OrderRoutingRuleApi', + }, + ], + category: 'Target APIs', + subCategory: 'Contextual APIs', + related: [], +}; + +export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/api/picker/picker.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/picker/picker.doc.ts index 615078173e..7dfef2a097 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/picker/picker.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/picker/picker.doc.ts @@ -1,14 +1,15 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Picker', + name: 'Picker API', overviewPreviewDescription: 'Opens a Picker in your app', description: `The Picker API provides a search-based interface to help users find and select one or more resources that you provide, such as product reviews, email templates, or subscription options, and then returns the selected resource ids to your extension. > Tip: > If you are picking products, product variants, or collections, you should use the [Resource Picker](resource-picker) API instead.`, isVisualComponent: true, - category: 'API', + category: 'Target APIs', + subCategory: 'Utility APIs', thumbnail: 'picker.png', requires: 'an Admin [block](/docs/api/admin-extensions/unstable/extension-targets#block-locations), [action](/docs/api/admin-extensions/unstable/extension-targets#action-locations), or [print](/docs/api/admin-extensions/unstable/extension-targets#print-locations) extension.', @@ -102,7 +103,7 @@ const data: ReferenceEntityTemplateSchema = { }, related: [ { - name: 'Resource Picker', + name: 'Resource Picker API', subtitle: 'APIs', url: 'resource-picker', type: 'pickaxe-3', diff --git a/packages/ui-extensions/src/surfaces/admin/api/print-action/print-action.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/print-action/print-action.doc.ts index 11bf769d69..4d3a4cd84b 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/print-action/print-action.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/print-action/print-action.doc.ts @@ -13,8 +13,8 @@ const data: ReferenceEntityTemplateSchema = { type: 'PrintActionExtensionApi', }, ], - category: 'API', - subCategory: 'Target APIs', + category: 'Target APIs', + subCategory: 'Core APIs', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/api/product-configuration/product-details-configuration.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/product-configuration/product-details-configuration.doc.ts new file mode 100644 index 0000000000..6f4274b4b2 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/api/product-configuration/product-details-configuration.doc.ts @@ -0,0 +1,21 @@ +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; + +const data: ReferenceEntityTemplateSchema = { + name: 'Product Details Configuration API', + description: + 'This API is available to product configuration extensions that render on the product details page. See the [tutorial](/docs/apps/selling-strategies/bundles/product-config) for more information.', + isVisualComponent: false, + type: 'API', + definitions: [ + { + title: 'ProductDetailsConfigurationApi', + description: '', + type: 'ProductDetailsConfigurationApi', + }, + ], + category: 'Target APIs', + subCategory: 'Contextual APIs', + related: [], +}; + +export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.doc.ts new file mode 100644 index 0000000000..679bcd79ca --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.doc.ts @@ -0,0 +1,21 @@ +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; + +const data: ReferenceEntityTemplateSchema = { + name: 'Product Variant Details Configuration API', + description: + 'This API is available to product configuration extensions that render on the product variant details page. See the [tutorial](/docs/apps/selling-strategies/bundles/product-config) for more information.', + isVisualComponent: false, + type: 'API', + definitions: [ + { + title: 'ProductVariantDetailsConfigurationApi', + description: '', + type: 'ProductVariantDetailsConfigurationApi', + }, + ], + category: 'Target APIs', + subCategory: 'Contextual APIs', + related: [], +}; + +export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/api/purchase-options-card-action.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/purchase-options-card-action.doc.ts new file mode 100644 index 0000000000..b9780d7343 --- /dev/null +++ b/packages/ui-extensions/src/surfaces/admin/api/purchase-options-card-action.doc.ts @@ -0,0 +1,21 @@ +import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; + +const data: ReferenceEntityTemplateSchema = { + name: 'Purchase Options Card Configuration API', + description: + 'This API is available to action extensions that render in the purchase options card on product and product variant details pages when selling plan groups are present.', + isVisualComponent: false, + type: 'API', + definitions: [ + { + title: 'PurchaseOptionsCardConfigurationApi', + description: '', + type: 'PurchaseOptionsCardConfigurationApi', + }, + ], + category: 'Target APIs', + subCategory: 'Contextual APIs', + related: [], +}; + +export default data; diff --git a/packages/ui-extensions/src/surfaces/admin/api/resource-picker/resource-picker.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/resource-picker/resource-picker.doc.ts index b139be0620..959f75638c 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/resource-picker/resource-picker.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/resource-picker/resource-picker.doc.ts @@ -1,7 +1,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; const data: ReferenceEntityTemplateSchema = { - name: 'Resource Picker', + name: 'Resource Picker API', overviewPreviewDescription: 'Opens a Resource Picker in your app', description: `The Resource Picker API provides a search-based interface to help users find and select one or more products, collections, or product variants, and then returns the selected resources to your app. Both the app and the user must have the necessary permissions to access the resources selected. @@ -9,7 +9,8 @@ const data: ReferenceEntityTemplateSchema = { > If you are picking app resources such as product reviews, email templates, or subscription options, you should use the [Picker](picker) API instead. `, isVisualComponent: true, - category: 'API', + category: 'Target APIs', + subCategory: 'Utility APIs', thumbnail: 'resource-picker.png', requires: 'an Admin [block](/docs/api/admin-extensions/unstable/extension-targets#block-locations), [action](/docs/api/admin-extensions/unstable/extension-targets#action-locations), or [print](/docs/api/admin-extensions/unstable/extension-targets#print-locations) extension.', @@ -152,7 +153,7 @@ const data: ReferenceEntityTemplateSchema = { ], related: [ { - name: 'Picker', + name: 'Picker API', subtitle: 'APIs', url: 'picker', type: 'pickaxe-3', diff --git a/packages/ui-extensions/src/surfaces/admin/api/should-render/should-render.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/should-render/should-render.doc.ts index 0d2b4e8f67..8401bf068c 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/should-render/should-render.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/should-render/should-render.doc.ts @@ -1,7 +1,7 @@ import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs'; const data: ReferenceEntityTemplateSchema = { - name: 'ShouldRender API', + name: 'Should Render API', description: 'This API controls the render state of an admin action extension. Learn more in the admin extensions tutorial.', isVisualComponent: false, @@ -13,7 +13,8 @@ const data: ReferenceEntityTemplateSchema = { type: 'ShouldRenderApi', }, ], - category: 'API', + category: 'Target APIs', + subCategory: 'Utility APIs', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/api/standard/standard.doc.ts b/packages/ui-extensions/src/surfaces/admin/api/standard/standard.doc.ts index cd0b594b0a..3daa8d5632 100644 --- a/packages/ui-extensions/src/surfaces/admin/api/standard/standard.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/api/standard/standard.doc.ts @@ -12,8 +12,8 @@ const data: ReferenceEntityTemplateSchema = { type: 'StandardApi', }, ], - category: 'API', - subCategory: 'Target APIs', + category: 'Target APIs', + subCategory: 'Core APIs', related: [], }; diff --git a/packages/ui-extensions/src/surfaces/admin/components/AdminAction/AdminAction.ext.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/AdminAction/AdminAction.ext.doc.ts index 712c7e0b53..d030fc31e6 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/AdminAction/AdminAction.ext.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/AdminAction/AdminAction.ext.doc.ts @@ -22,7 +22,7 @@ const data: ReferenceEntityTemplateSchema = { }, ], category: 'Polaris web components', - subCategory: 'Other', + subCategory: 'Settings and templates', defaultExample: { image: '/assets/templated-apis-screenshots/admin/components/adminaction-example.png', diff --git a/packages/ui-extensions/src/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.ts index d9d2f97126..cbf59c2f9d 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/AdminBlock/AdminBlock.ext.doc.ts @@ -17,7 +17,7 @@ const data: ReferenceEntityTemplateSchema = { }, ], category: 'Polaris web components', - subCategory: 'Other', + subCategory: 'Settings and templates', subSections: [ { title: 'Considerations', diff --git a/packages/ui-extensions/src/surfaces/admin/components/AdminPrintAction/AdminPrintAction.ext.doc.ts b/packages/ui-extensions/src/surfaces/admin/components/AdminPrintAction/AdminPrintAction.ext.doc.ts index f2bc16777c..970d1e104b 100644 --- a/packages/ui-extensions/src/surfaces/admin/components/AdminPrintAction/AdminPrintAction.ext.doc.ts +++ b/packages/ui-extensions/src/surfaces/admin/components/AdminPrintAction/AdminPrintAction.ext.doc.ts @@ -17,7 +17,7 @@ const data: ReferenceEntityTemplateSchema = { }, ], category: 'Polaris web components', - subCategory: 'Other', + subCategory: 'Settings and templates', defaultExample: { image: '/assets/templated-apis-screenshots/admin/components/adminprintaction-example.png',