ixartz/Next-js-Boilerplate

Need a clearer component in the storybook.

CO0Ki3 opened this issue · 3 comments

CO0Ki3 commented

image

I think the advantage of storybooks is to intuitively show what changes occur in various ways, such as changing props of components.

However, I don't think the current components are enough to show this behavior.

Of course, if users are already familiar with the storybook, they will use it without difficulty. However, I think the user base who is looking for boilerplate is mostly next(or.. react) beginners.

I think putting components such as very simple buttons with props in a storybook for them would also help react beginners accessing this project.

ixartz commented

Our opinion are different but agree about the example is maybe not intuitively. So, I'm totally open to pull request.

The goal of a boilerplate is not to teach people. There are already a lot of resources online to learn (in this case, learn storybook): tutorial, official documentation, etc... The goal of the boilerplate is to provide configuration, so developers don't lose the time to configure from scratch. So, the user base can be beginner but also intermediate or advanced users.

Of course, they can add their own configuration or remove some configuration we don't want. The boilerplate is a just a starting point. At least this is how I use the boilerplate myself.

CO0Ki3 commented

It was definitely my guess to use it for beginners😞

Nevertheless, I think a few more examples are needed for the storybook. If there was a component in it that had a prop, I thought it would save me some time to look for documentation while developing, saying, 'How did I add a prop to this...?'

If you don't think the boilerplate fits this, you can close the issue. That's okay.

This is just my idea, and I respect your opinion :)

ixartz commented

Actually, I'm not proficient in Storybook and implemented the storybook based on: : #103. It's the first time I'm using Storybook, definitively we can make it more easier to use.

So, totally open to PR to improve it if you are thinking about a few more examples we can add.