docs(admin-extensions): migrate static pages to MDX and update build process#3943
docs(admin-extensions): migrate static pages to MDX and update build process#3943MitchLillie wants to merge 1 commit into2026-04-rcfrom
Conversation
…process Replace static doc.ts landing page files with MDX files copied from shopify-dev. Update build-docs.mjs to copy MDX static pages to the correct shopify-dev path during doc generation instead of running the now-broken generate-docs --isLandingPage pipeline. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
Hey @MitchLillie! I could be missing a ton of context (and apologies if I am!), but I think an easier route might be to have the MDX pages live only in |
|
The plan on shopify-dev side was to have the MDX files all live inside of Shopify-dev as we are not exporting the components that are being used in them. There is no guarantee that we won't change the API of those components and update all MDX files in our repo with the resulting change. If your files are outside of this then they won't get updated. Also since this is not the plan for all repos you would be in a situation where your MDX files are not to be edited in our repo but everyone else's are which is not something we want. For now I'd prefer to keep the source of truth for these files in MDX especially as things are in flux on our end. If this becomes a pain point for your team I'm happy to talk more about it to see what we can do to remedy that. |
Summary
What changed
Why
The `generate-docs --isLandingPage` pipeline no longer syncs pages to shopify.dev. Static pages are now individual MDX files in shopify-dev (per #10920). The package MDX files are the source of truth and get copied to shopify-dev on each docs generation run.
Testing
yarn docs:admin # or for a specific version: yarn docs:admin 2026-04ls ../../../shopify-dev/areas/platforms/shopify-dev/content/api/admin-extensions/unstable/ # Expected: index.mdx network-features.mdx targets.mdxWithout a monorepo checkout: the script will print
Not copying docs to shopify-dev because it was not foundand exit cleanly — no errors expected.🤖 Generated with Claude Code