Regenerate checkout docs JSON for 2025-07#4461
Open
timtrevor-shopify wants to merge 1601 commits into
Open
Conversation
Resolves shop/issues-retail#18291 ### Background Add a new example to the ChoiceList component documentation showing how to compose rich content within choices. ### 🎩 - Verify the new example renders correctly in the documentation - Confirm the example code is clear ### Checklist - [ ] I have 🎩'd these changes - [ ] I have updated relevant documentation --- > Once deployed to production it should be available at https://shopify.dev/docs/api/pos-ui-extensions/latest/polaris-web-components/forms/choicelist
Update Image.d.ts for POS in 2025-10
* Revised component, prop, and example descriptions Revisions on second half of components Fixes * Revised repetitive 'A callback function' statement * Fix links to point to 2025-10 * Incorporate feedback from Tim
…docs Clarify how to layout multiple form fields
Part of shop/issues-retail#21393 ### Background This component is not available in 2025-10. We shouldn't have example for it.
Part of shop/issues-retail#21459 [Companion shopify-dev PR](https://app.graphite.com/github/pr/Shopify/shopify-dev/65897/Update-POS-UI-Extension-storage-api-limitation-docs) ### Background Add back missing limitations & add additional detail on inactivity bullet for 2025-10 storage api docs.
Improve admin component documentation for common usage patterns
Add DropZone docs to admin extensions
### Background This PR updates the change set for this [PR](https://github.com/Shopify/ui-extensions/pull/3600/changes#diff-b0d8b06fd5f46cfbf596896db727ddbb310fb4051b8b8f5b6523ac44dd062d5a). We only release `patch` updates for official versions. This changeset was causing the package to bump from 2025.10 to 2025.11 which is not correct.
Version Packages (2025-10)
## Description
Updates the documentation for Metafield Definition and Metaobject Definition intents to include the correct data parameters:
- Adds `{ ownerType: 'Product' }` as the data parameter for Metafield Definition create and edit actions
- Replaces the value parameter with a data parameter `{ type: 'my_metaobject_definition_type' }` for Metaobject Definition edit action
- Updates the corresponding example code for editing a Metaobject Definition to use the data parameter instead of the value parameter
## 🎩
- Verify that the updated documentation accurately reflects the expected parameters for these intents
- Confirm that the example code works correctly with the new parameter structure
## Checklist
- [ ] I have 🎩'd these changes
- [ ] I have updated relevant documentation
Add changeset to fix npm latest tag
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…5-10 Update suggestions limit and isLocationFormVisible descriptions
- market: use relative link, clarify ambiguous "It" pronoun - instructions: reference "cart instructions" explicitly, link to Cart Instructions API - storage: "activated targets associated with" per reviewer suggestion Made-with: Cursor
…ts-2025-10 Remove version-dated callouts from API descriptions
The applyTrackingConsentChange note incorrectly referenced the customer_privacy capability. The correct name is collect_buyer_consent. Updated link to point to the capabilities documentation. Made-with: Cursor
Adds JSDoc to OrderStatusApi.authenticationState (read-only framing) and OrderStatusApi.requireLogin (dismissal-handling guidance) on the customer account API surface. Picks up content trimmed from the .mdx in shopify/world#663262 review feedback. References shopify/issues-learn#1612. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
…25-10 # Conflicts: # packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts
The bullet list enumerated capabilities that don't all apply to customer account. The description already links to the configuration docs where valid capabilities are documented per surface. Made-with: Cursor
Add JSDoc for API properties (2025-10)
Without this tag, the doc generator doesn't extract the Navigation interface members, resulting in an empty Properties section. Made-with: Cursor
The bullet list is redundant with the type's resolved values and causes incorrect capabilities to appear on non-checkout surfaces. The description already links to the configuration docs. Made-with: Cursor
Without @publicdocs the generator falls back to a default description. Also aligned the description to match newer versions. Made-with: Cursor
…-name-2025-10 Fix collect_buyer_consent and extension type description
Remove inaccurate `applyGiftCardChange` JSDoc claim (2025-10)
…25-10 Remove doc validation skills
Simplify to state what to use instead of when it was deprecated. Co-authored-by: Cursor <[email protected]>
…uts-2025-10 Remove version dates from CA extensionPoint deprecated tags
Add JSDoc for component properties (2025-10)
Each screen runs in its own isolated sandbox. This adds a Limitations bullet so developers know module-level state, closures, and singletons aren't shared across screens, and points to the state option / Storage API as the supported way to pass data between screens.
docs(pos): note per-screen sandbox in Navigation API limitations
…upport_label_slot__2025-10 Update checkbox docs to support label slot (2025-10)
…025-10) (#4448) ## Summary Removes the self-referential "Refer to Storefront API access examples for more information" link from the `query` property description in `StandardApi`. The link points to the same page the reader is already on, which is confusing and unhelpful. Fixes shop/issues-learn#2084 ## Test plan - [ ] Verify the generated docs no longer include the self-referential link on the Storefront API page Made with [Cursor](https://cursor.com)
Run yarn docs:checkout 2025-10 to refresh generated_docs_data.json and generated_docs_data_v2.json. Co-authored-by: Cursor <[email protected]>
Run yarn docs:checkout 2025-07 to refresh generated_docs_data.json and generated_docs_data_v2.json. Co-authored-by: Cursor <[email protected]>
Contributor
🚨🚨🚨 Docs migration in progress 🚨🚨🚨We are actively migrating UI extension reference docs to MDX in the
During this migration, please be aware of the following:
Doc comments in Examples that previously lived in this repo are being moved to the What should I do?
Thanks for your patience while we complete the migration! 🙏 |
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
20 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.
Summary
Regenerates checkout UI extensions documentation data by running
yarn docs:checkout 2025-07.Files
packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.jsonpackages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.jsonMade with Cursor