Skip to content

[Customer account UI extensions 2024-10]: Set up component sidebar#4083

Merged
mcvinci merged 2 commits into2024-10from
customer-account-ui-extensions-components-ia-2024-10
Mar 11, 2026
Merged

[Customer account UI extensions 2024-10]: Set up component sidebar#4083
mcvinci merged 2 commits into2024-10from
customer-account-ui-extensions-components-ia-2024-10

Conversation

@mcvinci
Copy link
Contributor

@mcvinci mcvinci commented Mar 10, 2026

This PR:

  • Adds .doc.ts files and examples for ~60 shared checkout components (plus Chat and StyleHelper) to the customer account surface, so component reference pages are generated directly instead of linking out to checkout
  • Migrates the doc build pipeline from build-docs.sh to build-docs.mjs with parallel doc generation and proper type resolution
  • Creates build-doc-shared.mjs (utility module required by build-docs.mjs) and helper.docs.ts for the customer-account surface (fixing ~13 component docs that failed to compile due to a missing import)
  • Passes the full checkout source as --typesInput and adds React types for reference docs, with surface blanking during builds to avoid duplicate type conflicts
  • Removes the empty category overview page so subcategories render directly from component entries
  • Aligns subcategories across shared component docs to match the new sidebar IA (e.g., "Feedback" → "Feedback and status indicators", "Interactive" → "Media and visuals")
  • Relates to https://github.com/shop/world/pull/486452
  • Partially closes https://github.com/Shopify/shopify-dev/issues/69153

@mcvinci mcvinci self-assigned this Mar 10, 2026
@mcvinci mcvinci added documentation Improvements or additions to documentation Customer account UI extensions #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness labels Mar 10, 2026
@mcvinci mcvinci marked this pull request as ready for review March 10, 2026 22:28
@github-actions
Copy link
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

@mcvinci mcvinci requested a review from sordaz00 March 10, 2026 22:32
Copy link
Contributor

@sordaz00 sordaz00 left a comment

Choose a reason for hiding this comment

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

All seems good! One question: Claude notes that this new component documentation references 127 image files, but only 41 screenshots exist in the customer-account screenshots folder. We are planning to use previews - should all of the references be removed? If the references remain with the build will fail or be fine?

@mcvinci
Copy link
Contributor Author

mcvinci commented Mar 11, 2026

All seems good! One question: Claude notes that this new component documentation references 127 image files, but only 41 screenshots exist in the customer-account screenshots folder. We are planning to use previews - should all of the references be removed? If the references remain with the build will fail or be fine?

Good question! I think that we can probably clean up those references as part of working on component examples a bit later on. In addition, these doc.ts files will be going away shortly as @midhatdlg is migrating the customer account UI extensions docs to MDX. If the references remain for the time being, the build won't fail though.

@mcvinci mcvinci merged commit 26ff577 into 2024-10 Mar 11, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Customer account UI extensions documentation Improvements or additions to documentation #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