Skip to content

Remove mdx migration notice 2026 01#4485

Open
laurelthorburn wants to merge 1 commit into
2026-01from
laurel/remove-mdx-migration-notice-2026-01
Open

Remove mdx migration notice 2026 01#4485
laurelthorburn wants to merge 1 commit into
2026-01from
laurel/remove-mdx-migration-notice-2026-01

Conversation

@laurelthorburn
Copy link
Copy Markdown
Contributor

@laurelthorburn laurelthorburn commented May 22, 2026

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.yml on the 2026-01 version branch. Equivalent PRs are landing on 2025-07, 2025-10, 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 2026-01 no longer gets an auto-comment from the workflow

@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! 🙏

@laurelthorburn laurelthorburn changed the base branch from 2026-07-rc to 2026-01 May 22, 2026 20:43
@laurelthorburn laurelthorburn changed the title Laurel/remove mdx migration notice 2026 01 Remove MDX migration notice workflow (2026-01) May 22, 2026
@laurelthorburn laurelthorburn changed the title Remove MDX migration notice workflow (2026-01) remove mdx migration notice 2026 01 May 22, 2026
@laurelthorburn laurelthorburn changed the title remove mdx migration notice 2026 01 Remove mdx migration notice 2026 01 May 22, 2026
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.

1 participant