Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Website-based documentation with interactive examples #26

Open
kripod opened this issue Sep 20, 2019 · 0 comments
Open

Website-based documentation with interactive examples #26

kripod opened this issue Sep 20, 2019 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@kripod
Copy link
Owner

kripod commented Sep 20, 2019

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 kripod added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Sep 20, 2019
@kripod kripod pinned this issue Sep 20, 2019
@kripod kripod mentioned this issue Oct 9, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kripod