Adding documentation
July 23, 2020 ยท View on GitHub
In this guide, we'll walk through adding documentation for our fully test custom Strong component.
We mainly document 2 things for each component, its purpose and its interface.
Component purpose
A component's description and any notes worth mentioning (limitations, features, etc).
This is written in the stories mdx file.
Component interface
AKA props documentation, we use defaultProps and propTypes to document the component interface, this information is included directly in the component jsx file.
This documentation is automatically turned into a table inside storybook.
Next
Let's submit our component for review!