Remove version-dated callouts from API descriptions#4388
Conversation
Strip "as of version YYYY-MM" from deprecation notices, caution blocks, and tips. Includes additional 2025-07-specific cleanups for storefrontUrl, metafields, and storage descriptions. Made-with: Cursor
🚨🚨🚨 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! 🙏 |
|
We detected some changes in |
| * > Caution: As of version `2024-07`, UI extension code must check for instructions before calling select APIs in case those APIs are not available. | ||
| * See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) for more information. | ||
| * > Caution: Check instructions before calling select APIs, as some | ||
| * > may not be available. See the [update guide](/docs/api/checkout-ui-extensions/apis/cart-instructions#examples) |
There was a problem hiding this comment.
This URL currently redirects to /docs/api/checkout-ui-extensions/latest/target-apis/checkout-apis/cart-instructions-api. Should we explicitly state to refer to the Cart Instructions API? Check instructions felt a bit vague to me.
| * | ||
| * > Tip: | ||
| * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later. | ||
| * > Cart metafields are only available on carts created via the Storefront API. |
There was a problem hiding this comment.
| * > Cart metafields are only available on carts created via the Storefront API. | |
| * > Cart metafields are only available on carts created using the Storefront API. |
| * | ||
| * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier, | ||
| * each activated extension target had its own storage. | ||
| * Data is shared across all activated extension targets of this extension. |
There was a problem hiding this comment.
| * Data is shared across all activated extension targets of this extension. | |
| * Data is shared across all activated targets associated with this extension. |
There was a problem hiding this comment.
I'm not quite sure what an activated target is?
| * | ||
| * > Caution: | ||
| * > As of version `2024-04` this value will no longer have a trailing slash. | ||
| * The primary storefront URL. The URL does not include a trailing slash. |
There was a problem hiding this comment.
| * The primary storefront URL. The URL does not include a trailing slash. | |
| * The primary storefront URL. The URL doesn't include a trailing slash. |
- market: use relative link, clarify ambiguous "It" pronoun - instructions: reference "cart instructions" explicitly, link to Cart Instructions API - metafields: "created via" → "created using" - storage: "activated targets associated with" per reviewer suggestion - storefrontUrl: "does not" → "doesn't", add @example Made-with: Cursor
2 participants
Summary
Cascade of #4384 to 2025-07. Strip "as of version YYYY-MM" from deprecation notices and caution blocks. Includes additional cleanups specific to 2025-07:
storefrontUrl: Removed trailing-slash caution; states current behavior directlymetafields: Removed Storefront API version requirement from tipstorage: Removed old per-target storage migration noteinstructions: Removed version date from cautionextensionPoint: Simplified@deprecatedtagTest plan
Made with Cursor