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.

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

Finish the documentation #36

Open
tgfischer opened this issue Aug 3, 2020 · 0 comments
Open

Finish the documentation #36

tgfischer opened this issue Aug 3, 2020 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@tgfischer
Copy link
Owner

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
@tgfischer tgfischer added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Aug 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant