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
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.mdwould 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/Codepen