-
Notifications
You must be signed in to change notification settings - Fork 350
chore: separate stories into docs package #3152
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
Conversation
|
📦 Bundle Size Analysis ✅ No bundle size changes detected. Unchanged Components
📊 Summary:
|
PR Reviewer Guide 🔍(Review updated until commit 6aeace1)Here are some key observations to aid the review process:
|
rivka-ungar
left a comment
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!!
.../src/hooks/useActiveDescendantListFocus/__stories__/useActiveDescendantListFocus.stories.tsx
Show resolved
Hide resolved
| import { Link, Tip, UsageGuidelines } from "vibe-storybook-components"; | ||
|
|
||
| enum ThemeColor { |
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.
Add comment, to make sure they stay consistent
PR Type
Enhancement
Description
Migrated Storybook stories from
packages/coreto a new dedicatedpackages/docspackage, establishing a clear separation between component library and documentationConsolidated all story file imports to use centralized
@vibe/core,@vibe/core/next, and@vibe/core/interactionsTestspackage exports instead of relative pathsCentralized interaction test utilities by exporting
resetFocusfrom@vibe/core/interactionsTestsand consolidating test data IDs and constants into individual story filesUpdated Storybook configuration to discover and build stories from the new docs package, including webpack path aliases for core packages
Created comprehensive package infrastructure for docs package including
package.json, TypeScript configuration, and Vite configurationMigrated test utilities and constants from
@vibe/sharedpackage, includingContentColorByNamecolor mappings and test constantsUpdated GitHub Actions workflow (Chromatic) to reference the new docs package location
Removed deprecated
@vibe/storybook-configpackage and consolidated its utilities into the docs packageUpdated documentation and cursor rules to reflect new stories organization and import patterns
Diagram Walkthrough
File Walkthrough
69 files
ThemeProvider.interactions.ts
Consolidate imports and inline utility functions for themeinteractionspackages/docs/src/pages/components/ThemeProvider/ThemeProvider.interactions.ts
@vibe/coreand@vibe/core/interactionsTestspackagesaddAppThemeSuffix,getBodySystemThemeClassName,getComputedVarColor,hexToRgb) that werepreviously imported from separate files
SystemThemeimport to use type import from@vibe/coreSystemTheme.DARKto"dark"Combobox.interactions.ts
Centralize interaction test imports to core packagepackages/docs/src/pages/components/Combobox/Combobox.interactions.ts
@vibe/core/interactionsTestspackage@vibe/core/interactionsTestsimport@vibe/sharedfor test constants and utilitiesresetFocusimport in favor of centralized versionDialog.interactions.ts
Consolidate Dialog test data and interaction importspackages/docs/src/pages/components/Dialog/Dialog.interactions.ts
@vibe/core/interactionsTestsCLICK_OUTSIDE_DIALOG,CONTEXT_MENU_DIALOG, etc.)from separate file into this file as exports
DialogDataTestIdsfileColorPicker.interactions.ts
Consolidate ColorPicker test utilities and importspackages/docs/src/pages/components/ColorPicker/ColorPicker.interactions.ts
@vibe/core/interactionsTestsContentColorByNamecolor mapping that was previously importedfrom utils
@vibe/sharedfor test constantsresetFocusimportuseActiveDescendantListFocus.interactions.ts
Centralize hook interaction test importspackages/docs/src/pages/hooks/useActiveDescendantListFocus/useActiveDescendantListFocus.interactions.ts
@vibe/core/interactionsTests@vibe/sharedfor test constants__stories__directory to localmodule
playground-helpers.ts
Update playground helpers to use centralized package importspackages/docs/src/pages/playground/playground-helpers.ts
@vibe/coreand@vibe/core/nextpackages instead of local paths
VibeHooksimport and reference from exported playgroundcomponents
interactions-utils.ts
Export resetFocus utility functionpackages/core/src/tests/interactions-utils.ts
resetFocusfunction export that was previously defined elsewhereHeading.interactions.ts
Consolidate Heading test constants and interaction importspackages/docs/src/pages/components/Heading/Heading.interactions.ts
@vibe/core/interactionsTestsONE_LINE_ELLIPSIS_TEST_ID,OVERFLOW_TITLE_CONTAINER_ID) into this file as exportsText.interactions.ts
Consolidate Text test constants and interaction importspackages/docs/src/pages/components/Text/Text.interactions.ts
@vibe/core/interactionsTestsONE_LINE_ELLIPSIS_TEST_ID,OVERFLOW_TEXT_CONTAINER_ID) into this file as exportsClickable.interactions.ts
Centralize Clickable interaction test importspackages/docs/src/pages/components/Clickable/Clickable.interactions.ts
@vibe/core/interactionsTestsMenu.interactions.ts
Centralize Menu interaction test importspackages/docs/src/pages/components/Menu/Menu.interactions.ts
@vibe/core/interactionsTestsimport
useGridKeyboardNavigationContext.interactions.ts
Centralize grid keyboard navigation interaction importspackages/docs/src/pages/components/GridKeyboardNavigationContext/useGridKeyboardNavigationContext.interactions.ts
@vibe/core/interactionsTestsimport
colors-utils.ts
Convert ColorUtils to named exportpackages/shared/src/utils/colors-utils.ts
ColorUtilsfrom default export to named exportObject.freeze()wrapper from exportEditableHeading.interactions.ts
Centralize EditableHeading interaction test importspackages/docs/src/pages/components/EditableHeading/EditableHeading.interactions.ts
@vibe/core/interactionsTests@vibe/sharedEditableText.interactions.ts
Centralize EditableText interaction test importspackages/docs/src/pages/components/EditableText/EditableText.interactions.ts
@vibe/core/interactionsTests@vibe/sharedSlider.interactions.ts
Centralize Slider interaction test importspackages/docs/src/pages/components/Slider/Slider.interactions.ts
@vibe/core/interactionsTestsimport
Accordion.interactions.ts
Centralize Accordion interaction test importspackages/docs/src/pages/components/Accordion/Accordion.interactions.ts
@vibe/core/interactionsTestsimport
Tooltip.interactions.ts
Update Tooltip test constant importspackages/docs/src/pages/components/Tooltip/Tooltip.interactions.ts
@vibe/sharedinstead of localpath
RadioButton.interactions.ts
Centralize RadioButton interaction test importspackages/docs/src/pages/components/RadioButton/RadioButton.interactions.ts
@vibe/core/interactionsTestsDropdown.interactions.ts
Centralize legacy Dropdown interaction test importspackages/docs/src/pages/components/Dropdown/legacy/Dropdown.interactions.ts
@vibe/core/interactionsTestsuseActiveDescendantListFocus.module.scss
Update SCSS import to use monday-ui-style packagepackages/docs/src/pages/hooks/useActiveDescendantListFocus/useActiveDescendantListFocus.module.scss
monday-ui-stylepackageLoader.stories.tsx
Add Loader component storiespackages/docs/src/pages/components/Loader/Loader.stories.tsx
VisualVariants, LoaderInTextField, and LoaderInButton stories
@vibe/corepackageChips.stories.tsx
Update Chips stories to use centralized importspackages/docs/src/pages/components/Chips/Chips.stories.tsx
@vibe/corepackageNOOPutility with inline arrow functionModalSideBySideLayout.stories.tsx
Update Modal SideBySide layout stories importspackages/docs/src/pages/components/Modal/ModalSideBySideLayout.stories.tsx
@vibe/coreand@vibe/core/nextpackagesFieldLabeltoLabelcomponentText.stories.tsx
Update Text stories to use centralized importspackages/docs/src/pages/components/Text/Text.stories.tsx
@vibe/corepackageHeadingType.H3to string literal"h3"component-description-map.tsx
Update component description map importspackages/docs/src/layout/related-components/component-description-map.tsx
HiddenTextDescriptionimportdescriptions directory
Icon.stories.tsx
Update Icon stories to use centralized importspackages/docs/src/pages/components/Icon/Icon.stories.tsx
@vibe/corepackageFlexcomponentSlider.stories.tsx
Update Slider stories to use centralized importspackages/docs/src/pages/components/Slider/Slider.stories.tsx
@vibe/corepackageDialog.stories.tsx
Update Dialog stories to use centralized importspackages/docs/src/pages/components/Dialog/Dialog.stories.tsx
@vibe/corepackagedialogTriggerEventsarray inline instead of importing fromconstants
@vibe/coreLabel.stories.tsx
Update Label stories to use centralized importspackages/docs/src/pages/components/Label/Label.stories.tsx
@vibe/corepackageNOOPutility with inline arrow functionAccordion.stories.tsx
Migrate to centralized core package importspackages/docs/src/pages/components/Accordion/Accordion.stories.tsx
@vibe/corepackage imports__tests__directorymenu-grid-item-description.tsx
Update imports to use core packagepackages/docs/src/layout/related-components/descriptions/menu-grid-item-description.tsx
DummyNavigableGridimport path from__stories__to local pagesdirectory
MenuGridItemimport to use@vibe/corepackageExpandCollapse.stories.tsx
Centralize imports to core packagepackages/docs/src/pages/components/ExpandCollapse/ExpandCollapse.stories.tsx
@vibe/corepackage
../../../utils/createStoryMetaSettingsDecoratorBreadcrumbsBar.mdx
Consolidate component imports to core packagepackages/docs/src/pages/components/BreadcrumbsBar/BreadcrumbsBar.mdx
@vibe/corepackageCheckbox.mdx
Update imports to centralized core packagepackages/docs/src/pages/components/Checkbox/Checkbox.mdx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorcontent-colors.tsx
Migrate to centralized package importspackages/docs/src/pages/foundations/colors/content-colors/content-colors.tsx
ContentColorByNameimport to@vibe/sharedpackageTextcomponent import to use@vibe/corepackageSpacing.mdx
Update component imports to core packagepackages/docs/src/pages/foundations/spacing/Spacing.mdx
Textimport to use@vibe/corepackageSpacingStoriesimport pathAttentionBox.mdx
Migrate to centralized core package importspackages/docs/src/pages/components/AttentionBox/AttentionBox.mdx
AttentionBoximport to@vibe/core/nextpackage@vibe/corepackageTable.mdx
Consolidate table component importspackages/docs/src/pages/components/Table/Table.mdx
@vibe/corestatement
Tabs.mdx
Consolidate tab component importspackages/docs/src/pages/components/Tabs/Tabs.mdx
@vibe/corepackageVirtualizedGrid.stories.tsx
Migrate to centralized core packagepackages/docs/src/pages/components/VirtualizedGrid/VirtualizedGrid.stories.tsx
VirtualizedGridandButtonimports to@vibe/corepackageFleximport to use centralized packageMenuItem.stories.tsx
Migrate menu imports to core packagepackages/docs/src/pages/components/Menu/MenuItem.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorBadge.mdx
Consolidate imports and update asset pathspackages/docs/src/pages/components/Badge/Badge.mdx
@vibe/corepackageIndicatorcomponent importNumberField.stories.tsx
Migrate to centralized core packagepackages/docs/src/pages/components/NumberField/NumberField.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratordialog-description.tsx
Consolidate dialog component importspackages/docs/src/layout/related-components/descriptions/dialog-description/dialog-description.tsx
@vibe/corepackageToggle.stories.tsx
Migrate to centralized core packagepackages/docs/src/pages/components/Toggle/Toggle.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorButtonGroup.stories.tsx
Migrate to centralized core packagepackages/docs/src/pages/components/ButtonGroup/ButtonGroup.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorTipseen.mdx
Consolidate tipseen imports to core packagepackages/docs/src/pages/components/Tipseen/Tipseen.mdx
@vibe/corepackagesplit-button-description.tsx
Consolidate split button importspackages/docs/src/layout/related-components/descriptions/split-button-description.tsx
@vibe/corepackageSplitButton.mdx
Migrate split button imports to corepackages/docs/src/pages/components/SplitButton/SplitButton.mdx
SplitButtonandButtonimports to@vibe/corepackagemenu-description.tsx
Consolidate menu component importspackages/docs/src/layout/related-components/descriptions/menu-description.tsx
@vibe/corepackageuseGridKeyboardNavigation.stories.tsx
Migrate hook to centralized core packagepackages/docs/src/pages/hooks/useGridKeyboardNavigation/useGridKeyboardNavigation.stories.tsx
Buttonimports to@vibe/corepackageInfo.stories.tsx
Migrate to centralized core packagepackages/docs/src/pages/components/Info/Info.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorLink.stories.tsx
Migrate link imports to core packagepackages/docs/src/pages/components/Link/Link.stories.tsx
Linkcomponent import to@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorBreadcrumbItem.stories.tsx
Migrate breadcrumb imports to corepackages/docs/src/pages/components/BreadcrumbsBar/BreadcrumbItem.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratortipseen-description.tsx
Consolidate tipseen importspackages/docs/src/layout/related-components/descriptions/tipseen-description.tsx
@vibe/corepackageIconButton.mdx
Consolidate icon button importspackages/docs/src/pages/components/IconButton/IconButton.mdx
@vibe/corepackageMenuItemButton.stories.tsx
Migrate menu imports to core packagepackages/docs/src/pages/components/Menu/MenuItemButton.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorDialogContentContainer.stories.tsx
Migrate to centralized core packagepackages/docs/src/pages/components/Dialog/DialogContentContainer.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorLinearProgressBar.stories.helpers.tsx
Consolidate progress bar importspackages/docs/src/pages/components/ProgressBars/LinearProgressBar.stories.helpers.tsx
@vibe/corepackageMultiStepIndicator.stories.tsx
Migrate multi-step indicator to corepackages/docs/src/pages/components/MultiStepIndicator/MultiStepIndicator.stories.tsx
MultiStepIndicatorandSteptype to@vibe/corepackagetypography.mdx
Consolidate typography importspackages/docs/src/pages/foundations/typography/typography.mdx
@vibe/corepackagebreadcrumbs-description.tsx
Consolidate breadcrumb importspackages/docs/src/layout/related-components/descriptions/breadcrumbs-description.tsx
@vibe/corepackageexpand-collapse-description.tsx
Consolidate expand-collapse importspackages/docs/src/layout/related-components/descriptions/expand-collapse-description/expand-collapse-description.tsx
@vibe/corepackageIconimport sourceuseAfterFirstRender.stories.tsx
Migrate hook to centralized core packagepackages/docs/src/pages/hooks/useAfterFirstRender/useAfterFirstRender.stories.tsx
@vibe/corepackagemenu-button-description.tsx
Consolidate menu button importspackages/docs/src/layout/related-components/descriptions/menu-button-description.tsx
@vibe/corepackageCheckbox.stories.tsx
Migrate to centralized core packagepackages/docs/src/pages/components/Checkbox/Checkbox.stories.tsx
@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorTextArea.stories.tsx
Migrate to centralized core packagepackages/docs/src/pages/components/TextArea/TextArea.stories.tsx
TextAreacomponent import to@vibe/corepackage../../../utils/createStoryMetaSettingsDecoratorVirtualizedList.stories.tsx
Consolidate virtualized list importspackages/docs/src/pages/components/VirtualizedList/VirtualizedList.stories.tsx
@vibe/corepackage7 files
main.ts
Configure Storybook to include core package stories and aliasespackages/docs/.storybook/main.ts
@vibe/corepackage (.mdxand.storiesfiles)@vibe/core/interactionsTests,@vibe/core/next,and
@vibe/corein webpack configurationdocs package stories
vite.config.ts
Add Vite configuration for docs packagepackages/docs/vite.config.ts
package.json
Create package.json for docs packagepackages/docs/package.json
@vibe/docspackage@vibe/core,@vibe/icons, and@vibe/sharedtools
preview.tsx
Update Storybook preview configuration pathspackages/docs/.storybook/preview.tsx
package
storybooksubdirectory tolayoutanddecoratorsdirectories
chromatic.yml
Update Chromatic workflow to docs package.github/workflows/chromatic.yml
packages/coretopackages/docstsconfig.json
Add TypeScript configuration for docspackages/docs/tsconfig.json
support
tsconfig.storybook.json
Add package path mappings to storybook configpackages/docs/tsconfig.storybook.json
@vibe/core,@vibe/core/next,@vibe/core/interactionsTests, and@vibe/shareddirectories
1 files
corner-settings.scss
Update SCSS mixins and remove typography importpackages/docs/src/pages/foundations/round-corners/corners-settings/corner-settings.scss
font-input()tovibe-text(text2, normal)2 files
storybook-stories.mdc
Update Storybook stories documentation for docs package.cursor/rules/storybook-stories.mdc
packages/docsinstead of
packages/coreorganization
@vibe/corepackage importsLoader.mdx
Update Loader documentation with component importspackages/docs/src/pages/components/Loader/Loader.mdx
@vibe/corepackageFlexandHeadingcomponentsbutton
Tipimport from storybook components3 files
withLiveEdit.tsx
Update LiveEditor import pathpackages/docs/src/decorators/withLiveEdit/withLiveEdit.tsx
LiveEditorimport path fromcomponentstolayoutdirectorydropdown-migration-guide.mdx
Update migration guide import pathpackages/docs/src/pages/components/Dropdown/dropdown-migration-guide.mdx
DiffCodeBlockimport path to use pages-level migration-guidedirectory
ModalSideBySideLayout.mdx
Update modal styles import pathpackages/docs/src/pages/components/Modal/ModalSideBySideLayout.mdx
101 files