Skip to content

Remove version-dated callouts from API descriptions#4384

Merged
sordaz00 merged 3 commits into
2026-07-rcfrom
fix/remove-version-dated-callouts-2026-07-rc
Apr 30, 2026
Merged

Remove version-dated callouts from API descriptions#4384
sordaz00 merged 3 commits into
2026-07-rcfrom
fix/remove-version-dated-callouts-2026-07-rc

Conversation

@sordaz00
Copy link
Copy Markdown
Contributor

@sordaz00 sordaz00 commented Apr 29, 2026

Summary

Strip "as of version YYYY-MM" from deprecation notices and caution blocks in checkout standard.ts. These are migration artifacts — the behavior is now standard and the dates are irrelevant to current developers.

  • market: Removed redundant Caution block; @deprecated now explains why instead of when
  • instructions: Removed version date from Caution; states the requirement directly
  • extensionPoint: @deprecated now says what to use instead of when it was deprecated

Closes: https://github.com/shop/issues-learn/issues/2001

Test plan

  • Verify generated docs no longer show version-dated callouts
  • Cascade to 2026-04, 2026-01, 2025-10, 2025-07

Made with Cursor

Strip "as of version YYYY-MM" from deprecation notices and caution
blocks. These are migration artifacts that add noise — the behavior
is now standard and the dates are irrelevant to current developers.

Made-with: Cursor
@github-actions
Copy link
Copy Markdown
Contributor

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

  • If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
  • If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

Copy link
Copy Markdown
Contributor

@mcvinci mcvinci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @sordaz00! Same suggestions as #4387 (review).

- 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
@sordaz00 sordaz00 merged commit f6a8465 into 2026-07-rc Apr 30, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants