You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
The text was updated successfully, but these errors were encountered:
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 theREADME.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:
README.md
/CodepenThe text was updated successfully, but these errors were encountered: