hairizuanbinnoorazman
commented
6 years ago @thedanielforum What kind of documentation is needed to be covered?
- Documentation on how to contribute?
- Documentation on how to use the package?
With regards to documentation work, myself and @MervLim have been experimenting a little by using the styleguidist package.
Refer to the link here: https://react-styleguidist.js.org/
The experiment was done on a separate branch and has not been merged yet. https://github.com/ulventech/dynamicdelta/tree/experiment_styleguidist
This is a sample image of how the documentation will kind of look like:
A few advantages of this is that the documentation work is done in markdown which is relatively easy to pick up. At the same time, we can use this live documentation to actually render out what we have been developing. You can embed code snippet into the markdown which would be rendered into the markdown documentation. An additional advantage is that the code snippets can be altered to test things out etc. With a sample account, you can probably try out the functionality of the component.
We should document the package more.