react-data-grid icon indicating copy to clipboard operation
react-data-grid copied to clipboard

Can you make a documentation?

Open samislam opened this issue 3 years ago • 3 comments

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?

samislam avatar Sep 14 '22 12:09 samislam

I see that there is https://github.com/adazzle/react-data-grid/issues/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 avatar Sep 19 '22 10:09 tlehtimaki

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

tlehtimaki avatar Sep 19 '22 10:09 tlehtimaki

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

shusiner avatar Sep 20 '22 01:09 shusiner

Closing in favor of https://github.com/adazzle/react-data-grid/issues/2575

amanmahajan7 avatar Oct 18 '22 22:10 amanmahajan7