search

jhamill34 / storybook-addon-color-mode

Storybook add-on to be able to change the color modes of components
MIT License
1 stars 0 forks source link

Update documentation for CSF #14

Open jhamill34 opened 4 years ago

jhamill34 commented 4 years ago

It looks like the documentation on the README is lacking in how actually to use the plugin. An example should be added, showing how to use the withThemeProvider in a story as well as exactly how to configure it.

Also, the documentation should migrate to the new CSF syntax since that seems to be where Storybook is moving.

mrmartineau commented 4 years ago

+1 for this, because as you know (#13) I could not get it to work. Do you think that the docs should include docs for the multiple story formats that Storybook uses or just CSF? Also the new declarative config is much better IMO, do you want docs for that too?

jhamill34 commented 4 years ago

I don't think every type needs to be included but I do think an example usingwithThemeProvider should be included at the very least. Maybe add a link to the storybook docs for other formats?