react-data-table-component icon indicating copy to clipboard operation
react-data-table-component copied to clipboard

[FEATURE]: Add some specific remedial documentation

Open bmm-brobbins opened this issue 3 years ago • 0 comments

First of all, bless you. I've been struggling with react-table for a while and I'm guessing that RDT is going to substantially improve my development timeline, reduce challenges, and decrease headache.

As a new RDT user, here are some potential additions to documentation, which might get folks like me up and running faster.

  1. Storybook. New to me and maybe other RDT users. A few words describing just enough Storybook to understand it in the context of RDT's examples and documentation. Also, would my using it help in using RDT? With copying and modifying examples? If so what are the basic steps to get it up and running, and matching RDT's environment?

  2. API. The API itself is clearly documented. But how does an RDT user interact with the API? How and where in our code would this interaction be accomplished? For example I'm familiar with API in the context of machine-to-machine communication and fetching resources from remote servers. What does it mean in the context of co-resident interaction with the RDT library itself?

  3. How to "start a conversation"? Quoting: "...and even better start a converstaion about it" (from https://react-data-table-component.netlify.app/?path=/docs/getting-started-issues--page). Nothing is said about how or where to "start a conversation". (For example I suppose this posting would have been better as a "conversation" :)

These are pretty remedial, probably don't require more than a few paragraphs, and would be a big help to new users like me, and maybe others. I'm new at front-ending, mostly been number crunching on the back end, and am looking at RDT as a straightforward way to visualize all the custom JSON that I've been generating. Thank you.

bmm-brobbins avatar May 26 '22 09:05 bmm-brobbins