Skip to content

Conversation

@mcvinci
Copy link
Contributor

@mcvinci mcvinci commented Nov 13, 2025

This PR:

Tophatting

  1. In the ui-extensions repo, run yarn docs:point-of-sale 2025-07.
  2. In shopify-dev, run a server (dev server) and review the 2025-07 docs (descriptions for targets, APIs, and components) at https://shopify-dev.shop.dev/docs/api/pos-ui-extensions/2025-07

Known issues

  • Unable to create different descriptions on API and component index pages versus detailed API and component pages. For the time being, I've just added the long description that is intended for the details pages.
  • Some nested descriptions get duplicated, given the existing generated docs infrastructure. Hoping that we can resolve this as we continue the templated refs project work.

Focus for reviewers

I'm mainly looking for a gut-check on the following:

  • Do the descriptions convey the necessary context?
  • Are the descriptions positioned in the right place? (Typically, above interfaces and fields)
  • Are the changes scoped to descriptions only? Or have we accidentally updated / added types?

@mcvinci mcvinci changed the base branch from 2025-10 to 2025-07 November 13, 2025 06:58
@mcvinci mcvinci self-assigned this Nov 13, 2025
@mcvinci mcvinci added #gsd:47443 Templated References https://vault.shopify.io/gsd/projects/47443 and removed cla-needed labels Nov 13, 2025
@mcvinci mcvinci marked this pull request as ready for review November 13, 2025 08:22
@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 force-pushed the pos-ui-extensions-2025-07-api-prop-descriptions branch from e8c8c92 to 4f3c8b7 Compare November 13, 2025 08:28
@mcvinci mcvinci force-pushed the pos-ui-extensions-2025-07-api-prop-descriptions branch from 9d2995c to 7e50725 Compare November 17, 2025 09:02
@mcvinci mcvinci changed the title [POS UI extensions]: Improved API, component, and prop descriptions for 2025-07 [POS UI extensions]: Improved target, API, component descriptions for 2025-07 Nov 17, 2025
@mcvinci mcvinci force-pushed the pos-ui-extensions-2025-07-api-prop-descriptions branch from b646558 to 667a5f8 Compare November 17, 2025 10:07
Add target descriptions for POS extension targets

Update target descriptions from 2025-10 (partial - home, return post)

Complete target descriptions from 2025-10 (all remaining targets)

Improved descriptions for targets, APIs, and components

Improved descriptions
@mcvinci mcvinci force-pushed the pos-ui-extensions-2025-07-api-prop-descriptions branch from 27b8ba7 to 806428d Compare November 17, 2025 11:44
Copy link

@johndcollett johndcollett left a comment

Choose a reason for hiding this comment

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

structure looks good

@mcvinci mcvinci merged commit 633746e into 2025-07 Nov 25, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

#gsd:47443 Templated References https://vault.shopify.io/gsd/projects/47443

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants