Storybook: Fix component descriptions in manifest files#77112
Merged
Conversation
aduth
added
Storybook
|
Size Change: 0 B Total Size: 7.75 MB ℹ️ View Unchanged
|
|
Flaky tests detected in d8531bc. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/24578852248
|
This was referenced Apr 8, 2026
Member
Author
See: #77382 |
aduth
force-pushed
the
fix/component-stories-storybook-manifest
branch
from
8169c59 to
d8531bc
Compare
|
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 If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Member
Author
|
Marking this ready for review so that we can improve component documentation for MCP being introduced in #77159. The Storybook upgrade is stalled in #77382 due to a couple upstream Storybook bugs. In d8531bc I added lint enforcement to enforce the pattern for the components to be picked up correctly. It might also be something we want to apply to |
mirka
approved these changes
Apr 20, 2026
Member
mirka
left a comment
mirka
left a comment
There was a problem hiding this comment.
Also smoke tested some prop tables in Storybook, no issues 👍
ciampo
pushed a commit
that referenced
this pull request
Apr 21, 2026
* Storybook: Fix component descriptions in manifest files * Simplify to directory import * Fix Popover import * Use consistent import semantics in stories * Use no-restricted-imports to forbid import syntax Co-authored-by: aduth <aduth@git.wordpress.org> Co-authored-by: mirka <0mirka00@git.wordpress.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Fixes published Storybook component manifest to ensure correct component descriptions are included.
Example: https://wordpress.github.io/gutenberg/manifests/components.html
"A badge component for displaying labels with semantic intent" is the wrong description.
Draft:
We should do one of the following:
Why?
So that component descriptions are accurate based on implementation documentation.
How?
These are documented correctly in code, so it appears to be an issue with how Storybook resolves components.
The proposed fix was based on an observation of how this wasn't problematic with the output of some components that already used this approach for importing components from its source (
Card,Collapsible,Dialog,Notice). It's a hacky fix around how Storybook (more specifically, likelyreact-docgen-typescript) is unable to follow the imports. The hypothesis is that it chooses Badge description because the previous code points to the root barrel index and Badge is the first export in that file.I went down a long rabbit hole of trying to find related issues and release notes about this problem in related packages. I'll plan to share those more completely as this takes shape. But my attempts to update to newer versions were unsuccessful due to some errors about package resolution. And while newer versions support Vite 8+, there may be some blockers for us to use that (e.g. Node/ESM support).
Testing Instructions
Verify manifest output:
npm run storybook:buildopen storybook/build/manifests/components.html)AlertDialog.Rootand other@wordpress/uicomponentsUse of AI Tools
Used Claude Code + Opus 4.6 in the troubleshooting process and implementing the import workaround based on the working convention of other components.