search

storybookjs / storybook

Storybook is the industry standard workshop for building, documenting, and testing UI components in isolation
https://storybook.js.org
MIT License
84.39k stars 9.28k forks source link

Configuration API documentation #17243

Open justin-barca-at-camis opened 2 years ago

justin-barca-at-camis commented 2 years ago

Is your feature request related to a problem? Please describe I want to know the shape of the data of "parameters" in preview.js and it does not seem to be clearly defined in the documentation. The "API" section of the docs does not provide a comprehensive list of all parameters.

Describe the solution you'd like Provide comprehensive documentation for all configuration interfaces.

Describe alternatives you've considered Use tools to auto-document Typescript interfaces/types

Are you able to assist to bring the feature to reality? no

Additional context Add any other context or screenshots about the feature request here.

justin-barca-at-camis commented 2 years ago

I even downloaded this whole repository in hopes of being able to search for the typescript types but I can't seem to find the definitions with my IDE to help me search for likely symbols.

gwvt commented 2 years ago

Yes, complete documentation in one place of the API, including parameters, would be extremely useful and I think a high priority for such a robust (and awesome!) tool...

thedamon commented 2 years ago

What an opportunity to demonstrate automated api documentation from jsdoc in storybook!

kylegach commented 1 year ago

Related discussion: https://github.com/storybookjs/storybook/discussions/22413