Skip to content

Website-based documentation with interactive examples #26

Description

@kripod

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions