playpauseandstop / react-sadness

useRequest hook & set of components for requesting API data within React applications

Home Page:https://react-sadness.vercel.app

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Provide API documentation

playpauseandstop opened this issue · comments

It is great to have a storybook with examples on how to use react-sadness, but there is a need to provide an API documentation as well.

API documentation should highlight:

  • useRequest
  • SadnessProvider
  • SadnessConfig
  • Response
  • Loading & other components to render response
  • records

storybook-readme is a good choice to integrate that documentation into current storybook stories