Skip to content

Port work from https://github.com/Shopify/extensibility/pull/517 #3016

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: 2025-10-rc
Choose a base branch
from

Conversation

gwyneplaine
Copy link
Contributor

@gwyneplaine gwyneplaine commented Jun 26, 2025

Background

Port over work from https://github.com/Shopify/extensibility/pull/517

cc @mpshopify

Checklist

  • I have 🎩'd these changes
  • I have updated relevant documentation

@gwyneplaine gwyneplaine marked this pull request as ready for review June 26, 2025 03:07
Copy link
Contributor Author

gwyneplaine commented Jun 26, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Member

@alex-page alex-page left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good just needs some CI fixes

@themarkappleby
Copy link

themarkappleby commented Jun 27, 2025

Hi @gwyneplaine. I'm trying to tophat this PR by running yarn docs:admin 2025-10-rc but I'm getting the following error:

Error: Unable to find code file, '../../examples/patterns/details.jsx', in the doc file: 'src/surfaces/admin/components/patterns/details.ab.doc.js'.
    at /Users/markappleby/src/github.com/Shopify/ui-extensions/node_modules/@shopify/generate-docs/dist/generate-docs/src/assembler/contentModifications/createCodeTabs.js:42:19
    at Array.map (<anonymous>)
    at createCodeTabs (/Users/markappleby/src/github.com/Shopify/ui-extensions/node_modules/@shopify/generate-docs/dist/generate-docs/src/assembler/contentModifications/createCodeTabs.js:33:71)
    at addExamplesToDocs (/Users/markappleby/src/github.com/Shopify/ui-extensions/node_modules/@shopify/generate-docs/dist/generate-docs/src/assembler/docModifications/addExamplesToDocs.js:13:58)
    at /Users/markappleby/src/github.com/Shopify/ui-extensions/node_modules/@shopify/generate-docs/dist/generate-docs/src/assembler/docModifications/addGeneratedContentToDocs.js:13:51
    at Array.forEach (<anonymous>)
    at addGeneratedContentToDocs (/Users/markappleby/src/github.com/Shopify/ui-extensions/node_modules/@shopify/generate-docs/dist/generate-docs/src/assembler/docModifications/addGeneratedContentToDocs.js:8:18)
    at parseDocFiles (/Users/markappleby/src/github.com/Shopify/ui-extensions/node_modules/@shopify/generate-docs/dist/generate-docs/src/assembler/assembler.js:80:63)
    at async Promise.all (index 0)
node:fs:581
  return binding.open(
                 ^

Error: ENOENT: no such file or directory, open ''
    at Object.openSync (node:fs:581:18)
    at Object.writeFileSync (node:fs:2342:35)
    at /Users/markappleby/src/github.com/Shopify/ui-extensions/node_modules/@shopify/generate-docs/dist/generate-docs/src/assembler/assembler.js:100:12 {
  errno: -2,
  code: 'ENOENT',
  syscall: 'open',
  path: ''
}

Re: the shopify-dev repo, I'm on the latest version of main. Am I doing something wrong?

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.

4 participants