Skip to content

Update Typography and Content component descriptions (2026-04)#4295

Merged
sordaz00 merged 1 commit into2026-04from
typography-web-components-2026-04
Apr 14, 2026
Merged

Update Typography and Content component descriptions (2026-04)#4295
sordaz00 merged 1 commit into2026-04from
typography-web-components-2026-04

Conversation

@sordaz00
Copy link
Copy Markdown
Contributor

@sordaz00 sordaz00 commented Apr 14, 2026

Summary

  • Cascades Typography and Content component description updates from 2026-04-rc to the stable 2026-04 branch
  • Enriches all interface, property, event, and slot descriptions to match admin quality bar
  • Adds inline value descriptions for type union properties directly in source

Test plan

  • yarn build passes
  • Verify no generated files included
  • Regen docs locally to verify descriptions

Made with Cursor

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 14, 2026

🚨🚨🚨 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! 🙏

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 14, 2026

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.

rennyG
rennyG approved these changes Apr 14, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@rennyG rennyG left a comment

Choose a reason for hiding this comment

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

Approving to unblock, similar comments to #4296

@sordaz00
Update Typography and Content component descriptions to match admin q…
4a869d1 
…uality

Updates JSDoc descriptions for all Typography and Content web components
(Text, Heading, Paragraph, Abbreviation, OrderedList, UnorderedList,
ListItem, Time, Details, Summary, SkeletonParagraph, Chip, ClickableChip).

- Replace old "element props interface" pattern with "Configure the following
  properties on the [name] component." across all 13 .d.ts files
- Enrich Details events interface and toggle/aftertoggle descriptions
- Add Chip/ClickableChip slots interface descriptions
- Align shared property descriptions with admin quality (id, color, tone,
  accessibilityVisibility, display, fontVariantNumeric, lang, dir, lineClamp)
- Convert all @see tags to inline "Learn more" links
- Fix PascalCase component names in prose to lowercase
- Enrich type value descriptions (ParagraphType, TextType) in source
- Fix CA doc files (Time casing, OrderedList/UnorderedList grammar)

Made-with: Cursor
@sordaz00 sordaz00 force-pushed the typography-web-components-2026-04 branch from 63b4f07 to 4a869d1 Compare April 14, 2026 23:31
@sordaz00 sordaz00 merged commit 7d0304a into 2026-04 Apr 14, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rennyG rennyG rennyG approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sordaz00 @rennyG