Skip to content

[POS UI extensions]: Improved target, API, component descriptions for 2025-10 #3556

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.

Sign up for GitHub

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

Jump to bottom
Merged
mcvinci merged 13 commits into from
Nov 25, 2025
Merged

[POS UI extensions]: Improved target, API, component descriptions for 2025-10 #3556

mcvinci merged 13 commits into from
Nov 25, 2025

Conversation

@mcvinci
Copy link
Contributor

@mcvinci mcvinci commented Nov 10, 2025 •
edited
Loading

This PR:

Tophatting

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

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 title [POS UI extensions]: Improved API and prop description for 2025-10 [POS UI extensions]: Improved API and prop descriptions for 2025-10 Nov 10, 2025
@mcvinci mcvinci self-assigned this Nov 10, 2025
@mcvinci mcvinci added the #gsd:47443 Templated References https://vault.shopify.io/gsd/projects/47443 label Nov 12, 2025
@mcvinci
Improved API and prop descriptions fo 2025-10
81b1119 
Component prop descriptions

Component descriptions in index page cards

Event data descriptions

Type descriptions

component descriptions

lint

Prop description fixes

Additional context in descriptions

contractions

break up longer descs

remove enhanced / improved language
@mcvinci mcvinci force-pushed the pos-ui-extensions-2025-10-api-prop-descriptions branch from be68794 to 81b1119 Compare November 12, 2025 01:09
@mcvinci mcvinci marked this pull request as ready for review November 12, 2025 01:49
@mcvinci mcvinci requested a review from NathanJolly November 12, 2025 01:49
@github-actions
Copy link
Contributor

github-actions bot commented Nov 12, 2025

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 johndcollett November 12, 2025 01:50
@mcvinci mcvinci changed the title [POS UI extensions]: Improved API and prop descriptions for 2025-10 [POS UI extensions]: Improved API, component, and prop descriptions for 2025-10 Nov 12, 2025
@mcvinci mcvinci changed the title [POS UI extensions]: Improved API, component, and prop descriptions for 2025-10 [POS UI extensions]: Improved target, API, component descriptions for 2025-10 Nov 17, 2025
@mcvinci mcvinci force-pushed the pos-ui-extensions-2025-10-api-prop-descriptions branch from bd71d88 to efe4ccb Compare November 17, 2025 08:40
johndcollett
johndcollett approved these changes Nov 24, 2025
View reviewed changes
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 is good.

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

Reviewers

@johndcollett johndcollett johndcollett approved these changes

@NathanJolly NathanJolly Awaiting requested review from NathanJolly

@timtrevor-shopify timtrevor-shopify Awaiting requested review from timtrevor-shopify

@austin-schaefer austin-schaefer Awaiting requested review from austin-schaefer

Assignees

@mcvinci mcvinci

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@mcvinci @johndcollett