Skip to content

[App Home]: Fix docs build script#4168

Merged
mcvinci merged 1 commit into2026-04-rcfrom
app-home-docs-script-fix-2026-04-rc
Mar 19, 2026
Merged

[App Home]: Fix docs build script#4168
mcvinci merged 1 commit into2026-04-rcfrom
app-home-docs-script-fix-2026-04-rc

Conversation

@mcvinci
Copy link
Copy Markdown
Contributor

@mcvinci mcvinci commented Mar 18, 2026

This PR:

  • Fixes duplicate Polaris web components in generated App Home docs: The transformJson merge filter was missing the "Polaris web components" category, causing entries from the Shopify Dev docs source to duplicate those already produced by the doc generator.
  • Adds "Polaris web components" to the category exclusion list so only the freshly generated entries are included in the final output, matching the existing handling of "Web components" and "Patterns".

@mcvinci mcvinci self-assigned this Mar 18, 2026
@mcvinci mcvinci added App Home / App Bridge #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness labels Mar 18, 2026
@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! 🙏

@mcvinci mcvinci marked this pull request as ready for review March 19, 2026 00:02
@mcvinci mcvinci merged commit 9591f1c into 2026-04-rc Mar 19, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

App Home / App Bridge #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants