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.

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

feat(react-ui-kit): storybook #6860

Merged
merged 11 commits into from
Feb 3, 2025
Merged

feat(react-ui-kit): storybook #6860

merged 11 commits into from
Feb 3, 2025

Conversation

olafsulich
Copy link
Contributor

@olafsulich olafsulich commented Jan 31, 2025

Description

What's changed:

  • added the Storybook config
  • added stories for most of the components, those who already had some docs (it's not perfect, but a little bit improved for what was before)
  • removed everything related to styleguideist (.md files, config)
  • added an ADR for documentation and decision process

What's next:

  • folder structure, better organization by component type (i have left everything the same as it was before)
  • improve components stories - stories aren't perfect, we should improve them to have more examples, some may not work perfectly fine (don't want to spend time on it now)
  • deployment to Netlify (current deployment is broken, but we can use the same link in the future)
  • component testing, accessibility testing, visual regression...

Demo:

Screen.Recording.2025-01-31.at.11.39.27.mov

Checklist

  • mentions the JIRA issue in the PR name (Ex. [WPB-XXXX])
  • PR has been self reviewed by the author;
  • Hard-to-understand areas of the code have been commented;
  • If it is a core feature, unit tests have been added;

@olafsulich olafsulich marked this pull request as ready for review January 31, 2025 11:26
Copy link

sonarqubecloud bot commented Feb 3, 2025

@olafsulich olafsulich merged commit d4f7214 into main Feb 3, 2025
10 checks passed
@olafsulich olafsulich deleted the feat/ui-storybook branch February 3, 2025 09:23
@paulwire paulwire added the echoes: technical-roadmap Work contributing to the Technical Roadmap, to improve our velocity or reduce the technical debt. label Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
echoes: technical-roadmap Work contributing to the Technical Roadmap, to improve our velocity or reduce the technical debt. type: feature / request ✨
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants