toss / suspensive

Manage asynchronous operations, timing, error handling and detecting intersection of elements easily (one of TanStack Query's community resources)
https://suspensive.org
MIT License
533 stars 51 forks source link

[Feature] seperate component's doc and hook's doc. #220

Closed manudeli closed 1 year ago

manudeli commented 1 year ago
          I think we need to seperate component's doc and hook's doc.

I think you intended combine this hook with component document, because it is related to this component. But I think it is more convenient to seperated component document with hook document

reference is below

image

Chakra's intend is like that,

If you need to use hook, check this link

image

But our document is mixed.

_Originally posted by @minsoo-web in https://github.com/suspensive/react/pull/216#discussion_r1359229781_

manudeli commented 1 year ago

I think these two situations are different. In the case of chakra-ui, the reason for dividing documents for the hook and component is that the two cannot be used together.

image

but in the case of Suspensive, it is a case where components and hooks to properly handle those components must be used together, so the official document also contains hook and component in one document. I think the content should be written together.

I close this issue first, reopen this issue if you disagree my thought