Skip to content

Commit 0749287

Browse files
authored
Add Storybook Documentation to README
1 parent 2052e30 commit 0749287

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,12 @@ Development-wise, I think we should always strive for universal changes if compo
5050

5151
Keeping the design system relevant is important for consistency in our app. Core product requirements should still take priority, but we should make the design system updates necessary for each effort before tackling nice-to-haves.
5252

53+
## ✏️ How do we write stories and documentation?
54+
55+
- For every component, we typically separate each variant out into its own story that gets exported.
56+
- Documentation lives in `Component.mdx` which references stories defined in `Component.stories.jsx`. See documentation style here in [Stories with arbitrary MDX](https://github.com/storybookjs/storybook/blob/master/addons/docs/docs/recipes.md#csf-stories-with-arbitrary-mdx).
57+
- See our [Storybook Notion Doc](https://www.notion.so/userinterviews1/Storybook-9a3585db57514ec783e39c78518ad5e6) for examples.
58+
5359
# Future additions to this document
5460

5561
## ⚙️ How do we update the design system?

0 commit comments

Comments
 (0)