@thecb/components 10.12.6-beta.0 → 11.0.0-beta.0

package/README.md

@@ -8,6 +8,7 @@ This library contains CityBase React components for use across all current and f
 - [Component styles](#component-styles)
 - [Storybook](#storybook)
   - [Storybook addons](#storybook-addons)
+  - [Storybook deployment](#storybook-deployment)
 - [Adding new components](#adding-new-components)
 - [Version bumping and publishing](#version-bumping-and-publishing)
   - [Version bumping](#version-bumping)
@@ -43,18 +44,21 @@ The following statement will inheritly be called with `yarn`, but you can run it
 
 ## Storybook
 
-This repo uses [React Storybook](https://storybook.js.org/basics/guide-react/) for interactive component display.
-
-### Storybook addons
-
-- [Actions](https://github.com/storybooks/storybook/tree/master/addons/actions)
-- [Knobs](https://github.com/storybooks/storybook/tree/master/addons/knobs)
+This repo uses [React Storybook](https://storybook.js.org/basics/guide-react/) v8 for interactive component display.
 
 Please include new component stories as this library will also be a sandbox.
 
 - `yarn storybook`
 - open browser to localhost:9001
 
+### Storybook addons
+
+The repo uses all of the standard addons that come with Storybook v8, including the box model visualizer, measuring tool, and themes. The themes are currently static themes derived from FCS output. For the time being, when changes are made to themes in FCS, those changes need to be replicated inside of the `.storybook/themes/` directory in order for component stories to pick up on them. Ideally in the future a script will dynamically pull FCS themes from UAT.
+
+### Storybook deployment
+
+Storybook is deployed to GitHub Pages via a workflow action. This action will run on pushes to the master branch. When new PRs are merged to master the action should run on the merge commit and update the deployed version of Storybook. The deployed version lives here: [GH Pages Storybook](https://citybaseinc.github.io/cb-components/). The code for this action lives in `.github/workflows/deploy-github-pages.yml`.
+
 ## Adding new components
 
 - New components may be added to this library via pull request. Only components that are currently used in, or expected to be used in, more than one CB frontend should be present in this library. Very niche application specific components should be kept in the `components/atoms` and `components/molecules` directory of their parent application.
@@ -176,3 +180,7 @@ To import multiple components
 ```
 
 ```
+
+### Publishing Storybook to GitHub Pages
+
+This is a test to see if the GH Actions publishing workflow is functional.