Storybook: Fix Overview doc #104049
Storybook: Fix Overview doc #104049
Conversation
mirka
added
Documentation
Regression
Jetpack Cloud live (direct link)
Automattic for Agencies live (direct link)
|
matticbot
added
the
[Status] Needs Review
|
This PR does not affect the size of JS and CSS bundles shipped to the user's browser. Generated by performance advisor bot at iscalypsofastyet.com. |
| @@ -4,7 +4,8 @@ module.exports = { | |||
| ...storybookDefaultConfig( { | |||
| stories: [ | |||
| '../{src,styles}/**/*.stories.{js,jsx,ts,tsx}', | |||
| '../{src,styles,.storybook}/**/*.mdx', | |||
| '../{src,styles}/**/*.mdx', | |||
| './**/*.mdx', | |||
There was a problem hiding this comment.
What files is this intended to match?
There was a problem hiding this comment.
They're intended to match the MDX files under packages/components/.storybook/. The original glob ../{src,styles,.storybook} used to work fine for this but I think something in the path resolution changed recently.
There was a problem hiding this comment.
Interesting that the ../src file matching still works 🤔 Maybe something specifically about traversing up and back into the same directory.
| @@ -17,6 +17,7 @@ yarn components:storybook:start | |||
| ## Special sections | |||
|
|
|||
| - **WP Overrides**: Automattic-specific overrides for WordPress Core components. | |||
| - **Still Internal**: Components that are still internal to the package and not exported. | |||
There was a problem hiding this comment.
Existing, but I wonder if this should just be "Internal", or maybe "Unpublished" or "Experimental". There's somethig awkward about "still internal" 😅
github-actions
bot
removed
the
[Status] Needs Review
Regression discovered while testing #103000
Proposed Changes
Fixes the "Cannot find module './.storybook/overview.mdx'" error when trying to load the main "Overview" MDX file in Storybook.
Also flattens some of the approved components to the top level.
Why are these changes being made?
This likely regressed in a recent dependency update.
Testing Instructions
yarn components:storybook:startand confirm that the main "Overview" file loads without error.Pre-merge Checklist