-
Notifications
You must be signed in to change notification settings - Fork 296
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
docs(style): remove storybook #1985
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The actions remains flexible to publish further storybook if needed
...s/core/src/storybook/stand-alone-documentaion/colors/background-colors/background-colors.jsx
Show resolved
Hide resolved
packages/core/src/storybook/stand-alone-documentaion/colors/colors.stories.mdx
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome!
@@ -16,7 +15,6 @@ | |||
"noImplicitAny": true, | |||
"baseUrl": ".", | |||
"allowSyntheticDefaultImports": true, | |||
"jsx": "react-jsx", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
are you sure that's not needed?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I assume it's not needed because we don't have react, do you think we should keep it anyway?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I saw you removed the react dep entirely that seems cool
...s/core/src/storybook/stand-alone-documentaion/colors/background-colors/background-colors.jsx
Show resolved
Hide resolved
"@types/jest": "^27.4.1", | ||
"changelog": "^1.4.2", | ||
"chromatic": "^6.20.0", | ||
"classnames": "^2.3.2", | ||
"clean-css-cli": "^4.3.0", | ||
"execa": "^5.1.1", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seems like this is also unused
packages/core/src/storybook/stand-alone-documentaion/colors/colors.stories.mdx
Show resolved
Hide resolved
packages/core/src/storybook/stand-alone-documentaion/colors/colors.stories.mdx
Show resolved
Hide resolved
<Canvas> | ||
<Story name="Background Colors"> | ||
<BackgroundColors /> | ||
</Story> | ||
</Canvas> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the pattern that you've used here is deprecated. we should use a stories file with <Canvas of
not urgent of course, can be fixed later, but let's create a task
we should anyway do the <Canvas of
instead of <Story of
refactor in all our stories
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes definitely
Warning
Please review carefully!
Now that we have a monorepo and a unified dev environment (in core storybook), we no longer need the style storybook. In addition, it saves some effort of maintaining two storybooks, makes the docs more centralized and have a single source of truth since the stories used to be documented in the style storybook are already documented in the core storybook.
Most of the changes are removal of storybook related files and dependencies, and the rest are adjustments for the current style documentation to be also snapshotted in Chromatic. So it also means the style chromatic project will be redundant.
Note regarding dependencies: I removed react-related dev dependencies as they were added for storybook only, so now it's a pure scss package. I also removed peer deps that were irrelevant ("prop-types", "react") - please verify me.
I did leave TS config since I think we better keep it if the package is gonna expand in the future (so we'll already get TS already) but I also think we shouldn't expand it to be wider than a css/scss library. Let me know what you think
https://monday.monday.com/boards/3532714909/pulses/6137941070