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

ArgTypes documentation #17681

Closed
thany opened this issue Mar 10, 2022 · 4 comments · Fixed by #22970
Closed

ArgTypes documentation #17681

thany opened this issue Mar 10, 2022 · 4 comments · Fixed by #22970

Comments

@thany
Copy link

thany commented Mar 10, 2022

Is your feature request related to a problem? Please describe
Missing ArgTypes documentation. There's only this which is a brief summary with some examples that don't even appear to match the screenshot. Confusing at best, iyam.

Describe the solution you'd like
A full reference of ArgTypes. What exactly can I do with them? A full API reference, not a bunch of examples.

Describe alternatives you've considered
Currently, I have to look at examples and combine code snippets from all over the place to hopefully be able to give Storybook an argType that it understands. Or, I have to look at the source code to see how they are parsed, in order to know what the capabilities are exactly. Other than that, we have no way to know for sure what the capabilities of ArgTypes are, given a single source of truth (i.e. official documentation).

Are you able to assist to bring the feature to reality?
No, I haven't built it, so I cannot know how exactly it works.

Additional context
It's important to realise that however awesome something is, if it's not made clear how to use it, it will eventually be percieved as confusing or difficult. With proper full documentation and API reference, this could be prevented. I know writing documentation is hard and boring and whatall, but it has to be done.

@jblevins1991
Copy link

Yeah, I honestly hated how verbose the thing that came before controls, but at least I knew how to use it. This is a painful at best dev experience. At worst, I am considering moving back to a deprecated plugin because it allows me perform the job my employer is paying me to do.

@jonniebigodes
Copy link
Contributor

We're aware of the fragmentation of the documentation and it's already being tracked. We're planning on getting consolidated, updated in one place similar to other parts of the documentation that were already redone.

Nonetheless thanks for bringing this to our attention we appreciate it.

Hope you all have a great weekend!

Stay safe

@avi5079
Copy link

avi5079 commented Mar 25, 2022

Hello @jonniebigodes,
I am a beginner to open source. I would like to learn by contributing to this repo. Can you please guide me in this project like how to get started?

@kylegach kylegach self-assigned this May 3, 2023
@kylegach
Copy link
Contributor

Related discussion: #22495 (comment)

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

Successfully merging a pull request may close this issue.

5 participants