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

How to use the documentation for packages? am i missing something? #1396

Closed
scobby opened this issue Apr 11, 2022 · 2 comments
Closed

How to use the documentation for packages? am i missing something? #1396

scobby opened this issue Apr 11, 2022 · 2 comments

Comments

@scobby
Copy link

scobby commented Apr 11, 2022

Describe the bug
Cant use the documentation and implement for a example for a select field

To Reproduce

  1. Go to 'https://react-md.dev/packages/form/select-field-demos#select-example-title'
  2. Change the appearance of the demo
  3. Where to find generated configuration for that item?

Expected behavior
In general the documentation is nice, but not easy to handle, because only in very less examples i can copy example code.

Demo Code:
Even in the Demo Section i would expect that i get a generated code for that particular selected configuration.
And if i click on the code view for many examples, they are generated from the configuration and not easy to use.

Code for Button:
For example for Button its just "Button"

So am i missing something? is there a better documentation with example code for the packages?
Currently i have to do relative big research on how to those packages, is this intended?

@mlaursen
Copy link
Owner

Ahh, whoops. Thanks for letting me know. It looks like I forgot to add simple examples for the Select components and mostly focused on trying to showcase the theming and features. I'll update the documentation site to show some simple examples to help out.

@scobby
Copy link
Author

scobby commented Apr 21, 2022 via email

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

No branches or pull requests

2 participants