lunchboxav / lunchboxav/brutalist-component

Use Storybook for component demonstration

Open
#3 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Svelte
Stars
4
Forks
1
PR merge metrics
No merged PRs in 30d

Description

I initially thought that it's not important, as I want to demonstrate the components through Svelte based website itself. But after some thinking, Storybook will help testing the component even more thoroughly. I should use this approach instead.

Note: other similar Design Systems documentation tool are also welcomed.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review how the components are currently demonstrated through the Svelte-based website, then evaluate Storybook and similar design-system documentation tools. Define which approach should replace or supplement the current demonstrations; done means the components are demonstrable and can be tested through the selected tool.

Written by the indexing model from the issue text.

Assessment

Tech stack
storybook
Domain
documentation, testing, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.