Update POS UI Extensions Compatibility Policy #2795
Conversation
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
runmad
reviewed
Apr 22, 2025
packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts
Outdated
Show resolved
Hide resolved
runmad
reviewed
Apr 22, 2025
packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts
Outdated
Show resolved
Hide resolved
runmad
reviewed
Apr 22, 2025
| 1. You update your extension to use the appropriate API version | ||
| 2. Merchants install a compatible POS app version released on or after the API release date | ||
|
|
||
| ## Version Support Timeline |
There was a problem hiding this comment.
Are you wanting to replace the existing Compatibility Policy?
runmad
reviewed
Apr 22, 2025
|
|
||
| Generally, only POS app versions released on or after the API release date can access features from that API version. | ||
|
|
||
| ## POS Design System and Your Extensions |
There was a problem hiding this comment.
We do not call it that externally.
Suggested change
| ## POS Design System and Your Extensions | |
| ## UI component and your extensions |
runmad
reviewed
Apr 22, 2025
packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts
Outdated
Show resolved
Hide resolved
runmad
reviewed
Apr 22, 2025
| - Shopify supports each version for 12 months from its release date | ||
| - Quarterly releases introduce new features | ||
|
|
||
| ### POS App Release Cycle |
There was a problem hiding this comment.
I am generally not a huge fan of LLM's Camel Casing everything, but not a hill I'd die on as long as we are consistent through the whole doc.
Suggested change
| ### POS App Release Cycle | |
| ### POS app release cycle |
runmad
reviewed
Apr 22, 2025
|
|
||
| ### How Design Changes Affect Your Extensions | ||
|
|
||
| When Shopify updates the POS design system: |
There was a problem hiding this comment.
Suggested change
| When Shopify updates the POS design system: | |
| When Shopify updates the POS visual design: |
|
I tested this tonight by running |
NathanJolly
reviewed
Apr 22, 2025
packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts
Outdated
Show resolved
Hide resolved
NathanJolly
reviewed
Apr 22, 2025
| 2. **API Version Release**: Shopify moves features to an official quarterly version (e.g., \`2025-07\`) | ||
| 3. **Merchant Availability**: Merchants can access features when they update to a compatible POS app version | ||
|
|
||
| Generally, only POS app versions released on or after the API release date can access features from that API version. |
There was a problem hiding this comment.
I don't think this is true. We always try to have POS "ready" for a new version by supporting it in the build immediately prior to the API release date.
There was a problem hiding this comment.
your point is v valid. I've seen it both ways. i will remove line 64 (generally,...) and we'll just need to note compatible versions of POS going fwd
NathanJolly
reviewed
Apr 22, 2025
packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts
Outdated
Show resolved
Hide resolved
NathanJolly
reviewed
Apr 22, 2025
packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts
Outdated
Show resolved
Hide resolved
NathanJolly
reviewed
Apr 22, 2025
packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pages/versions.doc.ts
Outdated
Show resolved
Hide resolved
…/pages/versions.doc.ts Co-authored-by: Rune Madsen <runemadsen@mac.com>
…/pages/versions.doc.ts Co-authored-by: Nathan Oliveira <nathanjollee@gmail.com>
…/pages/versions.doc.ts Co-authored-by: Nathan Oliveira <nathanjollee@gmail.com>
…/pages/versions.doc.ts Co-authored-by: Nathan Oliveira <nathanjollee@gmail.com>
…/pages/versions.doc.ts Co-authored-by: Nathan Oliveira <nathanjollee@gmail.com>
…/pages/versions.doc.ts Co-authored-by: Rune Madsen <runemadsen@mac.com>
saarahafeez
force-pushed
the
shafeez/versions-pos-ui-ext
branch
from
245551f to
48452dc
Compare
|
@NathanJolly @runmad can you take another look? @NathanJolly I think we remove the 'compatibility' policy (left nav, header, footer) - see attached images. this is just part of the versioning page for POS UI Ext and no longer needs its own section |
NathanJolly
previously approved these changes
Apr 24, 2025
runmad
reviewed
May 1, 2025
| 1. You update your extension to use the appropriate API version | ||
| 2. Merchants install a compatible POS app version | ||
|
|
||
| ## POS Visual Design and Your Extensions |
There was a problem hiding this comment.
Suggested change
| ## POS Visual Design and Your Extensions | |
| ## POS visual design and your extensions |
runmad
reviewed
May 1, 2025
Comment on lines
+44
to
+59
| ### Automatic Updates vs. Breaking Changes | ||
|
|
||
| 1. **Automatic Updates**: Your extension inherits visual refinements automatically when merchants update their POS app | ||
| 2. **Breaking Changes**: Shopify introduces these only with new quarterly API versions | ||
|
|
||
| #### Automatic Updates | ||
| - Minor design adjustments (colors, spacing, typography) | ||
| - UI component refinements | ||
| - Accessibility improvements | ||
| - Performance optimizations | ||
|
|
||
| #### Breaking Changes | ||
| - New component and API features | ||
| - Removal of deprecated component and API features | ||
| - Structural layout changes | ||
|
|
There was a problem hiding this comment.
Suggested change
| ### Automatic Updates vs. Breaking Changes | |
| 1. **Automatic Updates**: Your extension inherits visual refinements automatically when merchants update their POS app | |
| 2. **Breaking Changes**: Shopify introduces these only with new quarterly API versions | |
| #### Automatic Updates | |
| - Minor design adjustments (colors, spacing, typography) | |
| - UI component refinements | |
| - Accessibility improvements | |
| - Performance optimizations | |
| #### Breaking Changes | |
| - New component and API features | |
| - Removal of deprecated component and API features | |
| - Structural layout changes | |
| ### Automatic updates vs. breaking Changes | |
| **Automatic updates** | |
| - Visual refinements inherit automatically when merchants update their POS app | |
| - Includes: minor design adjustments (colors, spacing, typography), UI component refinements, accessibility improvements, and performance optimizations | |
| **Breaking changes** | |
| - Introduced only with new quarterly API versions | |
| - Includes: new component and API features, removal of deprecated features, and structural layout changes |
NathanJolly
dismissed
their stale review
This is a bit stale now, feel free to re-request review if you intend to merge this! If not, you can always close the PR.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
I expanded the Versions sections of POS UI Ext Dev Docs to try to help 3P developers understand:
Solution
I used Claude and the following inputs:
🎩
Checklist