bcgov / bcgov/wps

Add and configure Styleguidist

Open
#1,298 2 comments 0 reactions 0 assignees View on GitHub
4Refinement Task
Dominant language
Python
Stars
65
Forks
11
Avg merge
21h 25m
Merged PRs (30d)
70

Description

**Describe the task**
Storybook was removed because it had dependencies that clashed with CRA and `react-scripts`.

React Styleguidist is an alternative that installs and runs without issue (at least it did on
https://github.com/bcgov/wps/commit/4f9502765ca94188ae915ff3e36f5e03263be376)
**Acceptance Criteria**
- [ ] Install styleguidist
- [ ] Configure styleguidist to pick up our components

**Additional context**
- Tried React Cosmos already, has webpack runtime issues
- https://react-styleguidist.js.org
- https://react-styleguidist.js.org/docs/components

Contributor guide

Open the contributing guide

Research direction

Review the existing CRA/react-scripts setup and locate the project’s React components, then compare the configuration options in the linked React Styleguidist documentation. Install Styleguidist, configure it to discover the components, and verify that its component guide starts and displays them without the dependency conflicts described for Storybook.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
frontend, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.