Page MenuHomePhabricator

Consider tool to showcase the components
Open, Needs TriagePublic

Description

A component library should have a way to showcase its components and provide documentation about their use. In the past we used Storybook in the same repository as the components. For this new shared component library it makes sense to revisit this.

Open questions:

NOTE: UX should be part of the conversation and decision about this issue.

Resources

Related Objects

Event Timeline

Michael created this task.Oct 18 2019, 9:38 AM

From my initial thoughts it seems to make sense to start with storybook in the same repository for now. That should represent the state of the components at the tip of the master branch and facilitate communication from developers to UX.

In the future I see a need for something similar to the OOUI demo page.
This could then be maintained in a separate repository which would have several benefits:

  • easier to edit by UX people
  • changing only the documentation doesn't touch the component repository + doesn't trigger component CI
  • easier to maintain versioned documentation (if desired)
Michael updated the task description. (Show Details)Oct 18 2019, 9:47 AM