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

Can you make a documentation? #3015

Closed
samislam opened this issue Sep 14, 2022 · 4 comments
Closed

Can you make a documentation? #3015

samislam opened this issue Sep 14, 2022 · 4 comments

Comments

@samislam
Copy link

Use case

Learn this module

Proposed solution

Can you make up documentation for the module? I can't find any way I can learn this library except the npm page which doesn't include enough helpful information.

for such a rich amount of effort, it's a shame to publish a great package like that without documentation.
how am I going to use it then?

@tlehtimaki
Copy link

I see that there is #2575 about ongoing documentation efforts. Maybe you can help the maintainers and chip in your effort? The current https://adazzle.github.io/react-data-grid/ site offers quite a lot of examples too, but the documentation is not yet complete.

@tlehtimaki
Copy link

Also the code for those demos https://github.com/adazzle/react-data-grid/tree/main/website/demos might help you out.

@shusiner
Copy link

I am also looking at documentation for this library but I guess the demo code looks like it can be of great help. I think we should explicitly put the link to the demo code in README.md and tell people that they can copy those code and try it out. It didn't occur to me at the very beginning as I am used to looking for documentation

@amanmahajan7
Copy link
Contributor

Closing in favor of #2575

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

4 participants