Skip to content

[GoodBounty]: Polish storybook interaction and presentation #64

Description

@L03TJ3

Description

A fast iteration and polishing has been done to update the storybook stories presentation and structure.
The goal of the storybook presentation and environment tries to tackle different layers:

  • qa and testing (AI with playwright tests + manual interactive demos)
  • showcase of widgets
  • integrators documentation and developer guidance
  • documentation and demonstration on how to work with design system as widget builder
  • documentation and demonstration how integrators can tailor a widget in all UI aspects to fit their local branding

You can play around with the current live version on https://gooddollar-storybook.vercel.app.

What needs to be done

  • We have a beginning structure that all stories should follow
  • We have for all widgets on storybook working test flows and screenshot output
  • Clear and concise showcase and code examples that makes it easy for anyone to integrate into their own apps / write new widgets
  • Utilizing the storybook control layer, and making it possible to use storybook to interactively override states and settings for a given widget.
  • needs a human eye review to make sure things are aligned, demonstrated in a working way, guiding text and examples make sense, or things like: a widget is shown in different states on a page, but it looks the same? (not good wrapping and structuring of goodwidgetprovider maybe?)

The main structure as-is now setup should be kept. This boutny is about about polishing the content, the way widgets or components are demonstrated, including guiding documentation and code examples). And besides having an interactive demo functionality, it should also be interactive by being able to play with the design-system and override as we promote: 'almost all UI aspects of a given widget'.
This requires clear mapping of exposed styling variables and making it configurable/overridable through storybooks native controls feature.

Definition of done:

  • All stories are accomponied with controls to override using their exposed styling variables
  • All stories are reviewed and verified that the guiding text or code examples are clear instructions and implementation examples
  • Any simple encountered issue that stems not from storybook but from one of the components is resolved (UI wise). anything that needs larger fixes are clearly documented and reported on in either the resulting pull-request or an issue comment

Metadata

Metadata

Assignees

Labels

GoodBounties - RareLarger features, touches multiple areas

Type

No type
No fields configured for issues without a type.

Projects

Status
In Progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions