Draft
Conversation
This reverts commit 08a8d4e.
This reverts commit 358facf.
Njo/revert event target
POS UI Extensions API Component Documentation: Image and Box
Njo/2025 01 unstable
Made flex and flexChildren available again
[Checkout UI extensions] Add Localized Fields API to `Unstable`
[Checkout UI extensions] Optimizes localized field example comments
Unstable release of checkout
Updates unstable changelogs with 2025-01 changes
…kage Remove data extensions package
…rop-descriptions [POS UI extensions]: Improved target, API, and component descriptions for 2025-04
* Remove deprecated FormattedTextFieldComponent * Fix type error * Remove doc files * Fix type errors
…ey-api-update [2025-04] Update Buyer Journey API docs
* Add and improve descriptions for Target APIs * Resource picker and Picker revisions * Description feedback from Steve Revamp limitations + best practices Further revisions Revise newly added descriptions (cherry picked from commit b1ffa70) Fixes: Type fixes Fix docs generation (cherry picked from commit 812f1b2) (cherry picked from commit 7706f01) Co-authored-by: Cursor <cursoragent@cursor.com> * Remove accidentally added types * Integrate feedback from Steve * Update Standard API description to match available features Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
…path-2025-04 chore: update shopify-dev asset path
…-docs-2025-04 chore: update all paths in build-docs scripts 2025-04
Co-authored-by: Cursor <cursoragent@cursor.com>
[Target APIs content]: Examples and descriptions for 2025-04
… handling to targets.json scripts - Customer-account: Add generic recursive component parsing for AllComponents - Correctly resolves to 63 customer-account components (not checkout's 60) - Excludes Chat (not in shared-checkout-components.ts) - Includes local components (Card, Avatar, etc.) - Excludes @internal components (PolicyModal) - Admin: Add RunnableExtension support for should-render targets (27 new targets) - Admin: Add parseInlineComponentTypes for Pick/Omit handling - CustomerSegmentTemplateComponent correctly has 2 components - AllComponents correctly excludes 3 omitted components - Checkout: Add RunnableExtension support for address-autocomplete targets - Checkout: Add @Private target exclusion - POS: Add parseInlineComponentTypes for Pick handling - ActionComponents correctly has 1 component (Button) - SmartGridComponents correctly has 1 component (Tile) - All scripts: Add @Private JSDoc exclusion for targets
2025-04 target docs
Treat composite APIs (StandardApi, ActionTargetApi) as wrapper types: expand their constituent APIs in the generated targets but do not list the composite names in per-target apis or API reverse mappings.
The doc file was referencing example files with incorrect relative paths. Since the doc file is in purchase-options-card-action/ directory but the examples are in purchase-options-card/ directory, the paths need to go up one level first using ../ instead of ./ Co-authored-by: Cursor <cursoragent@cursor.com>
(cherry picked from commit c04d337)
* Make API headings consistent for Admin UI Co-authored-by: Cursor <cursoragent@cursor.com> * Make API headings consistent for POS UI Co-authored-by: Cursor <cursoragent@cursor.com> Minor fixes Remove files Update remaining POS API headings to Methods Co-authored-by: Cursor <cursoragent@cursor.com> * Remove reference to non-existent loading prop on Button Co-authored-by: Cursor <cursoragent@cursor.com> * Rename 'Methods' to 'Properties' in API headings and descriptions Co-authored-by: Cursor <cursoragent@cursor.com> * Remove 'methods' from API description text, use 'properties' instead Co-authored-by: Cursor <cursoragent@cursor.com> * Revert title for applyMetafieldChange back to original name Co-authored-by: Cursor <cursoragent@cursor.com> * Revert title for picker back to original name Co-authored-by: Cursor <cursoragent@cursor.com> * Revert specific function/method titles back to original names Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
Exclude ActionTargetApi and StandardApi from POS targets JSON
* Intros, best practices, limitations, and prop descriptions Linting Prop descriptions Linting Prop description improvements * Remove component name code styling Restore links + catch other code syntax instances Linting * Update selection-action target descriptions Co-authored-by: Cursor <cursoragent@cursor.com> * Incorporate feedback from Steve * Integrate feedback from tech writers session Co-authored-by: Cursor <cursoragent@cursor.com> * Integrate feedback from Steve --------- Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
[Components content]: Examples for 2025-04
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.
Background
Closes https://github.com/Shopify/shopify-dev/issues/68438
TL;DR: We are ready to begin the migration of POS docs to the latest major gen docs release.
Solution
Doc generation: Added
/** @publicDocs */immediately before every top level interface for POS ONLY.Why this approach: The existing doc pipeline uses
@publicDocsto decide what to include; adding the tag is the minimal, consistent fix and matches how other public API surfaces are documented.yarn docs:point-of-sale 2025-04to generate the generated docs data v2 json file in the shopify-dev repoChecklist