Storybook: Storybook + TypeScript Setup Documentation is Unclear

Created on 10 Aug 2020  路  4Comments  路  Source: storybookjs/storybook

Is your feature request related to a problem? Please describe.
I feel that the current structure of the TypeScript setup documentation is unorganized and not clear for users of certain environments. It's frustrating because I'm facing this problem and I do not know the full scope of what I do or do not need from the current documentation.

Describe the solution you'd like
I'd like for the TypeScript setup documentation to be reorganized into sections like or akin to the following:

  1. If you are using Storybook with Create React App + TypeScript
  2. If you are using Storybook with Ejected Create React App (or custom Webpack config)
  3. etc...

Describe alternatives you've considered
Storybook has the features that I need but not clear enough documentation.

Are you able to assist bring the feature to reality?
No, because I do not have the context to set up the Storybook tooling with TypeScript.

Additional context
None.

documentation help wanted todo

Most helpful comment

@thedanchez thank you for bringing this issue to our attention. We've done a bit of an overhaul on the documentation and tried to present the information consistently. As all documentation goes, we have room for additions and improvements and fine tuning where it should be fine tuned. I'm going to take a better look at it and see if we can come up with a possible solution for this, so that not only you, but the rest of the community can benefit as well.

Once i have a concrete answer materialized in the form of a pull request i'll mention this issue.

Sounds good?

Stay safe

All 4 comments

@thedanchez thank you for bringing this issue to our attention. We've done a bit of an overhaul on the documentation and tried to present the information consistently. As all documentation goes, we have room for additions and improvements and fine tuning where it should be fine tuned. I'm going to take a better look at it and see if we can come up with a possible solution for this, so that not only you, but the rest of the community can benefit as well.

Once i have a concrete answer materialized in the form of a pull request i'll mention this issue.

Sounds good?

Stay safe

@jonniebigodes Yes, absolutely! Really appreciate your attention on this -- I think this is going to be super valuable to users of Storybook.

The other thing I forgot to mention is also configuring the use of things like SCSS Modules in a TypeScript context within CRA or non-CRA environments so I'm hoping there's also content for that in the new documentation 馃槃

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

Was this page helpful?
0 / 5 - 0 ratings