Conversation
**Why:** Preparatory work ahead of upcoming FlowStateMachine v2 work, where it's expected a new form-steps package would need to share usage of these hooks with the existing document-capture package. [skip changelog]
| @@ -0,0 +1,3 @@ | |||
| # `@18f/identity-react-hooks` | |||
|
|
|||
| A collection of general-purpose [React hooks](https://reactjs.org/docs/hooks-intro.html). | |||
There was a problem hiding this comment.
Is it worth documenting the hooks in the README with examples? Or realistically these are internal so we should just look for internal usage?
There was a problem hiding this comment.
I'm conflicted, because on one hand, yes, it would be great to have documented examples. On the other hand, my experience is that those sorts of documentation fall out of sync with the implementation almost immediately. Ideally it would be something where we could generate the documentation out of the source code, but I'm not aware of any tooling that would produce what we'd want.
The main goal with including this was to try to be marginally better about documenting the purpose of each package for other developers on the team, so at least it's incrementally better in that regard 😅
2 participants
Why: Preparatory work ahead of upcoming FlowStateMachine v2 work, where it's expected a new form-steps package would need to share usage of these hooks with the existing document-capture package.