Skip to content

2026-04: Fix doc generation to resolve shopify-dev from World#4124

Draft
vctrchu wants to merge 1 commit into2026-04-rcfrom
vchu/fix-doc-gen-world-path
Draft

2026-04: Fix doc generation to resolve shopify-dev from World#4124
vctrchu wants to merge 1 commit into2026-04-rcfrom
vchu/fix-doc-gen-world-path

Conversation

@vctrchu
Copy link
Copy Markdown
Contributor

@vctrchu vctrchu commented Mar 17, 2026

Related to https://github.com/shop/issues-retail/issues/26023

TL;DR

Update doc generation path to resolve shopify-dev from the World monorepo instead of the deprecated standalone repo.

What changed?

  • resolveShopifyDevPath now resolves to ~/world/trees/root/src/areas/platforms/shopify-dev
  • Removed legacy fallback to ../../../shopify-dev (standalone repo)
  • Removed interactive prompt and unused readline import
  • Updated build-docs.mjs caller to match new signature (no args)

Why?

shopify-dev has moved into World at //areas/platforms/shopify-dev. The standalone repo is deprecated. Running yarn docs:point-of-sale should copy generated output directly to the World zone.

Note

This PR targets 2026-04-rc. The same change needs to be applied to other active version branches (e.g. 2025-10, 2026-01) since build-doc-shared.mjs and build-docs.mjs are shared across all versions. Cherry-pick or open matching PRs for other branches as needed.

How to test?

Requires //areas/platforms/shopify-dev in your sparse checkout:

tec checkout add //areas/platforms/shopify-dev

Then run yarn docs:point-of-sale 2026-04-rc — generated JSON should appear in ~/world/trees/root/src/areas/platforms/shopify-dev/db/data/docs/templated_apis/pos_ui_extensions/2026-04-rc/.

The standalone shopify-dev repo is deprecated — shopify-dev now lives
in World at //areas/platforms/shopify-dev. Remove the legacy fallback
and interactive prompt.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.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! 🙏

@vctrchu vctrchu changed the title Fix doc generation to resolve shopify-dev from World 2026-04: Fix doc generation to resolve shopify-dev from World Mar 17, 2026
@vctrchu vctrchu changed the base branch from 2026-04-rc to graphite-base/4124 March 17, 2026 23:29
@vctrchu vctrchu force-pushed the graphite-base/4124 branch from f59baae to c30b5f5 Compare March 17, 2026 23:29
@vctrchu vctrchu changed the base branch from graphite-base/4124 to main March 17, 2026 23:29
Copy link
Copy Markdown
Contributor Author

vctrchu commented Mar 17, 2026

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant