You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The reference docs migration to MDX (in areas/platforms/shopify-dev) is complete, so the PR-comment warning we added during the migration is no longer needed.
This PR removes .github/workflows/mdx-migration-notice.yml on the 2025-10 version branch. Equivalent PRs are landing on 2025-07, 2026-01, 2026-04, and 2026-07-rc.
What's removed
The MDX migration notice workflow that posted a comment on every new PR explaining that .doc.ts files, doc comments, and examples were being migrated.
Test plan
CI passes
After merge, opening a new PR against 2025-10 no longer gets an auto-comment from the workflow
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! 🙏
laurelthorburn
changed the title
remove mdx migration notice for gen docs
Remove MDX migration notice workflow (2025-10)
May 22, 2026
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
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.
laurelthorburn
changed the title
Summary
The reference docs migration to MDX (in
areas/platforms/shopify-dev) is complete, so the PR-comment warning we added during the migration is no longer needed.This PR removes
.github/workflows/mdx-migration-notice.ymlon the2025-10version branch. Equivalent PRs are landing on2025-07,2026-01,2026-04, and2026-07-rc.What's removed
MDX migration noticeworkflow that posted a comment on every new PR explaining that.doc.tsfiles, doc comments, and examples were being migrated.Test plan
2025-10no longer gets an auto-comment from the workflow