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

Better examples and documentation #470

Open
iaverypadberg opened this issue Mar 29, 2024 · 1 comment
Open

Better examples and documentation #470

iaverypadberg opened this issue Mar 29, 2024 · 1 comment

Comments

@iaverypadberg
Copy link

Is your feature request related to a problem? Please describe.
Starting out with this library is difficult. It's easy to get lost and with minimal code examples its unclear the best patterns for using the library.

Describe the solution you'd like
The examples put up on the Storybook page are not very engaging and there is no complete example where they fit into code. Take the Small Image example.

Additionally, this is a fairly complex library, and I find that I end up guessing on how to use it.

If there were a high level description of how use the library effectively it would make this library easier to adopt for new users.

@lukefrogger
Copy link

This library is really amazing, but I've struggled to learn the nuances of it. Even implementing something simple like <KeepScale /> took diving into the source code to figure out how to use.

Better docs or even real-life code examples would be incredibly helpful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants