Skip to content

Finish the documentation #36

@tgfischer

Description

@tgfischer

Currently I have a Storybook instance and an incomplete README.md. The idea was that Storybook would automate most of the documentation (e.g. what components are available, what their props are, how to use them), and the README.md would only document how to build and contribute to the project. However, from a user's point of view, I'm not sure if this is the most effective way to document it.

A few other options:

  • Document the components with Storybook MDX files
  • Use Docusaurus V2/Codepen
  • Use README.md/Codepen

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