-
-
Notifications
You must be signed in to change notification settings - Fork 185
WIP: feat(storybook): add addon-docs #241
WIP: feat(storybook): add addon-docs #241
Conversation
add @storybook/addon-docs package and react-is dependency and configure addon-docs loader in webpack BREAKING CHANGE: @storybook/addon-docs and react-is development dependencies fix #238
Here we need to summon @irvelervel too! |
@ocBruno to understand this PR, with this new add-on this part here will it have to be placed here? and then we'll have something like this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
conflicts must be solved
This one I wll also leave WIP as I am very new to webpack loaders and storybook so if anyone wants to pitch in some advice I will take a lot at the addon docs documentation to try to apply the code preview to the docs page as well as well as resolve the conflicts. Thanks for the feedback @jackcmeyer @fox1t @tehkapa @irvelervel ! |
change awesome-typescript-loader for more trending ts-loader, upgrade all @storybook packages to match addon-docs version, remove unnecssary react is, modify webpack and storybook config for package upgrades BREAKING CHANGE: replace awesome-typescript-loader for ts-loader, upgrade @storybook/* fix #238
BREAKING CHANGE: dependency upgrades and modifications fix #238
Hi @ocBruno! First of all thank you for your contribution, as always.
Have a nice day! 🙂 |
Hello @irvelervel thanks for the feedback! -The typescript loader was a suggestion I had but I should've opened a separate issue for it. I had suggested it because it could prove to be more reliable considering some have commented they had compiling speed improvements from it and it is trending more. The versioning was a beginner mistake but the addition of addon-docs was suggested by one of the storybook contributors in the following issue, saying that it fixed a bug with displaying code previews with too many nested objects in the component paramaters . Take a look at this for more info on addon-docs and what's coming to storybook The themes are applied to the storybook global UI and is documented here I will be reverting the typescript loader change and will dive deeper into storybook to be able to better contribute to the stories and configuration before removing the WIP from this PR. My main focus was fixing the preview styling bug but after seeing how addon-docs is part of storybooks near future I think I will also work on the other necessary changes to adapt the project for the initial upgrade to addon-docs if agreed upon. Thanks again and have a nice day too! 🚀 |
Ok, great @ocBruno! Are we facing this preview styling bug in some components at the moment? I'm not sure I'm fully understanding the problem you're talking about. Have a great day. |
Not sure if we still are but I am about to merge my branch with upstream to make sure they weren't resolved but I was having problems reproducible in the following issue. Update: |
Hey @irvelervel @tehkapa @jackcmeyer @fox1t, According to I will do some more debugging but I will leave the working config here for now in case anyone is interested in checking it out. Some of the reasons for the upgrade, differences of the storiesOf API and benefits of the new markup can also be found here. I only left the navbar incase this request doesn't go through but am willing to refactor the rest of the stories! |
Closed for inactivity and to save build time |
fix #238
Changes proposed in this pull request:
-Remove superceded addon-info by its new replacement addon-docs
-Refactor navbar storiesOfApi to recommendad CSF format
Newly added dependencies with Bundlephobia links: