Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add Storybook workflow doc #814

Merged
merged 1 commit into from
Aug 26, 2024
Merged

chore: add Storybook workflow doc #814

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions site/docs/pages/guides/contribution.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,18 @@ onchainkit

## Workflows

### Storybook
Copy link
Contributor

@cpcramer cpcramer Jul 16, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that this section needs more step by step guidance - I'm new to Storybook, and this section in its current state does not help me understand how contributing to onchainKit / Storybook works.


Storybook is a frontend workshop for building UI components and pages in isolation. It helps you develop and share hard-to-reach states and edge cases without needing to run your whole app.

To develop and test your components in Storybook, run the following command:

```bash
yarn storybook:dev

# In a browser, navigate to http://localhost:6006/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can leave this out since yarn storybook:dev auto directs the user to that url

```

### Testing

Write and update existing unit tests. You can watch file changes and rerun tests automatically like this:
Expand Down
Loading