Skip to content

Regenerate checkout docs JSON for 2026-04#4458

Open
timtrevor-shopify wants to merge 1 commit into
2026-04from
2026-04-update-generated-JSON
Open

Regenerate checkout docs JSON for 2026-04#4458
timtrevor-shopify wants to merge 1 commit into
2026-04from
2026-04-update-generated-JSON

Conversation

@timtrevor-shopify
Copy link
Copy Markdown
Contributor

Summary

Regenerates checkout UI extensions documentation data by running yarn docs:checkout 2026-04.

Files

  • packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.json
  • packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.json

Made with Cursor

Run yarn docs:checkout 2026-04 to refresh generated_docs_data.json and generated_docs_data_v2.json.

Co-authored-by: Cursor <cursoragent@cursor.com>
@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! 🙏

@github-actions github-actions Bot added the needs-rc-port PR against a stable branch awaiting forward-port to the current RC label May 14, 2026
@github-actions
Copy link
Copy Markdown
Contributor

This PR targets a stable release branch (2026-04). Once merged, the change typically also needs to be forward-ported to 2026-07-rc so it ships in the next release.

When you open the forward-port PR, include a line like this in its body so the needs-rc-port label gets removed automatically when that PR merges:

Forward-port of #4458

Accepted formats (comma-separated for multiple):

  • #4458
  • GH-4458
  • 4458
  • https://github.com/Shopify/ui-extensions/pull/4458

If a forward-port isn't needed (e.g., the change is stable-only), you can remove the needs-rc-port label manually.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-rc-port PR against a stable branch awaiting forward-port to the current RC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant