react-hooks icon indicating copy to clipboard operation
react-hooks copied to clipboard

Website-based documentation with interactive examples

Open kripod opened this issue 6 years ago • 0 comments

Motivation

Being readme-embedded, the documentation is starting to get cluttered and incomprehensible. Interactive playgrounds and use-cases should be provided for each hook and their configurable parameters.

Details

For example, Chakra UI provides concise and comprehensible docs for their components, packed with editable examples usable out of the box.

A similar approach is desired for standard-hooks, while keeping JSDoc comments in sync with the ones on the web, preferably with automation.

kripod avatar Sep 20 '19 15:09 kripod