Website-based documentation with interactive examples
- Dominant language
- TypeScript
- Stars
- 557
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
## 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](https://chakra-ui.com/button) 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.
Contributor guide
Research direction
Start by locating the README-embedded documentation and the JSDoc comments for each hook. Compare the desired Chakra UI-style interactive examples and determine how the website content and JSDoc could stay synchronized; done means the hooks and configurable parameters have usable playground examples and consistent documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100