Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configuration API documentation #17243

Open
justin-barca-at-camis opened this issue Jan 14, 2022 · 4 comments
Open

Configuration API documentation #17243

justin-barca-at-camis opened this issue Jan 14, 2022 · 4 comments
Assignees

Comments

@justin-barca-at-camis
Copy link

justin-barca-at-camis commented Jan 14, 2022

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
Copy link
Author

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
Copy link

gwvt commented May 9, 2022

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
Copy link

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

@kylegach
Copy link
Contributor

Related discussion: #22413

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: In Progress
Development

No branches or pull requests

5 participants