Skip to content

UI: Improve docs for compound exports#78212

Merged
mirka merged 1 commit into
trunkfrom
ui-export-docs
May 13, 2026
Merged

UI: Improve docs for compound exports#78212
mirka merged 1 commit into
trunkfrom
ui-export-docs

Conversation

@mirka
Copy link
Copy Markdown
Member

@mirka mirka commented May 12, 2026

What?

Follow up to #78184

Documents the expected metadata for @wordpress/ui compound component exports.

Why?

The conventions around Object.assign, displayName, JSDoc placement, and Storybook subcomponents metadata are easy to miss. Capturing them in the package contributing guide should help keep Storybook docs, React DevTools, and IDE tooltips consistent.

How?

Adds guidance to packages/ui/CONTRIBUTING.md for:

  • adding primary component JSDoc to both the implementation export and public Object.assign wrapper;
  • setting subcomponent displayName values to their full public compound names;
  • listing public subcomponents in Storybook metadata with dot-notation keys.

Testing Instructions

Instructions should be comprehensive, and should makes sense.

@github-actions github-actions Bot added the [Package] UI /packages/ui label May 12, 2026
@mirka mirka self-assigned this May 12, 2026
@mirka mirka added the [Type] Developer Documentation Documentation for developers label May 12, 2026
@mirka mirka marked this pull request as ready for review May 12, 2026 18:04
@mirka mirka requested a review from a team as a code owner May 12, 2026 18:04
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 12, 2026

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: mirka <0mirka00@git.wordpress.org>
Co-authored-by: aduth <aduth@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Copy Markdown
Member

@aduth aduth left a comment

Choose a reason for hiding this comment

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

Thanks for adding this 👍

@mirka mirka merged commit f4df834 into trunk May 13, 2026
47 of 48 checks passed
@mirka mirka deleted the ui-export-docs branch May 13, 2026 00:54
@github-actions github-actions Bot added this to the Gutenberg 23.2 milestone May 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Package] UI /packages/ui [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants