HSDS: React
  • HSDS: React
  • Quick start
    • Components
  • Testing
    • Local Integration Testing
  • Reporting Issues
  • Contributing
    • Getting started
    • Creating a component
    • Styling
    • Write a story
    • Writing tests
    • Adding documentation
    • Submitting for review
    • Publishing a release
Powered by GitBook
On this page
  • Component purpose
  • Component interface
  • Next
  1. Contributing

Adding documentation

PreviousWriting testsNextSubmitting for review

Last updated 4 years ago

In this guide, we'll walk through adding documentation for our .

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.

[See writing components]()

Next

Let's submit our component for !

fully test
custom Strong component
See writing stories
(https://hsds.helpscout.com/?path=/docs/%F0%9F%8F%A0-welcome-3-writing-components--page)
review