Better API documentation

[nicogreenarry]

• I have searched the issues of this repository and believe that this is not a duplicate.

What problem does this feature solve?

Much of the API documentation doesn't do much to explain what a given component is and how it would normally be used. Writing a few sentences about what each component is, and how/when you'd use it, could help people understand the library quite a bit better.

For example:

• What is the Brush component? The documentation (https://recharts.org/en-US/api/Brush) just describes the props. I found an example (https://recharts.org/en-US/examples/BrushBarChart), but even the example doesn't make it very clear what Brush is unless you open the CodeSandbox and play around with the code a bit.
• How is the Polygon used? It sounds from the name and the props listed in the documentation (https://recharts.org/en-US/api/Polygon) like I can specify points and I'll get a polygon on the chart, but I'm uncertain of that, because I don't see props that I'd expect in that case, e.g. props allowing me to control the style/appearance of the polygon.

What does the proposed API look like?

n/a

[ckifer]

Yep, agreed! The recharts website is hard to maintain because its in another repo.

To help with that we made a storybook (https://master--63da8268a0da9970db6992aa.chromatic.com). That storybook doesn't have a pretty URL, but it at least lives within the recharts repo and is much easier to update.

The storybook should be more up to date than the website is, but still isn't perfect. If anyone wants to help, please feel free to contribute.

[orinamio]

Hi @ckifer! I'd be happy to help here. Can you assign me to this issue?

[ckifer]

Sure!

This issue is rather large in scope - not sure the best way to structure it, but feel free to create new issues and associate them to this one if you feel the need to do smaller chunks of work at a time (i.e. Improve Brush Documentation, Improve Shape Documentation, etc.)

Another dimension to this is making sure the recharts website is even with the storybook, which it isn't at the moment (should be close though). Let me know if you need anything!