guardian / guardian/csnx

Decide what to do with Source eslint-plugins storybook READMEs and other Source stories

Open
#233 1 comment 0 reactions 2 assignees Claimed by @ob6160 View on GitHub
Dominant language
TypeScript
Stars
45
Forks
9
Avg merge
1d 9h
Merged PRs (30d)
17

Description

The eslint-plugins storybooks consist of just one story which is importing the project's README.

- Should these even be stories?
- Do we want to create AWS amplify projects for them if so?
- Or shall we just leave them as READMEs in the project?

There are also several other stories that pertain to Source generally that are currently all held together in the GH Pages storybook. As we are now splitting into a Storybook per package, we need to decide where these stories will sit.

Should we thus have a Source 'documentation' Storybook?

Should this also contain the Eslint plugin docs? Or should these be their own Storybook as they are packages (but only one README)? Do these have to be in AWS Amplify or can we keep using GH pages?

Should we keep separate package Storybooks for Foundations, Components and Dev Kitchen, or does it make sense to compose them all back into one large Storybook again (and include the docs above)?

About the packages - could these move into their individual Storybooks?:
![image](https://user-images.githubusercontent.com/15648334/204504915-4a17eab8-e8d1-4391-b85f-f584019d4b4e.png)

Contributing to Source - this pertains to all the packages:
![image](https://user-images.githubusercontent.com/15648334/204505615-0dc5fb83-8a77-4c1b-baae-644aba30d728.png)

Release notes (out of date - we now have separate versions for each package) - should we scrap or add to each package?:
![image](https://user-images.githubusercontent.com/15648334/204505225-f57a3074-9c95-4b67-af7b-81984130f6c1.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.