From 676349474d1329c2a4292ed34bf6d2e9e6a0494e Mon Sep 17 00:00:00 2001 From: Caleb Nance Date: Thu, 16 May 2024 21:17:31 -0400 Subject: [PATCH] docs: Adds Missing or Wrong Storybook Demo Links (#343) * added missing demo links to storybook * updated demo links to storybook that 404ing (because of the re-organization of components) * updated a few outlier headings that still had the skins syntax --- src/ebay-alert-dialog/README.md | 3 +++ src/ebay-badge/README.md | 4 ++-- src/ebay-breadcrumbs/README.md | 2 +- src/ebay-button/README.md | 2 +- src/ebay-calendar/README.md | 3 +++ src/ebay-carousel/README.md | 3 +++ src/ebay-checkbox/README.md | 4 ++-- src/ebay-confirm-dialog/README.md | 3 +++ src/ebay-cta-button/README.md | 2 +- src/ebay-date-textbox/README.md | 3 +++ src/ebay-drawer-dialog/README.md | 3 +++ src/ebay-eek/README.md | 2 +- src/ebay-fake-menu-button/README.md | 4 ++-- src/ebay-fake-menu/README.md | 4 ++-- src/ebay-fake-tabs/README.md | 4 ++-- src/ebay-field/README.md | 4 ++-- src/ebay-fullscreen-dialog/README.md | 3 +++ src/ebay-icon-button/README.md | 2 +- src/ebay-icon/README.md | 5 ++++- src/ebay-infotip/README.md | 4 ++-- src/ebay-inline-notice/README.md | 4 ++-- src/ebay-lightbox-dialog/README.md | 3 +++ src/ebay-listbox-button/README.md | 4 ++-- src/ebay-menu-button/README.md | 4 ++-- src/ebay-menu/README.md | 4 ++-- src/ebay-page-notice/README.md | 5 ++--- src/ebay-pagination/README.md | 3 +++ src/ebay-panel-dialog/README.md | 3 +++ src/ebay-progress-bar/README.md | 2 +- src/ebay-progress-spinner/README.md | 2 +- src/ebay-progress-stepper/README.md | 5 ++--- src/ebay-radio/README.md | 4 ++-- src/ebay-section-notice/README.md | 5 ++--- src/ebay-select/README.md | 2 +- src/ebay-signal/README.md | 4 ++-- src/ebay-snackbar-dialog/README.md | 3 +++ src/ebay-split-button/README.md | 2 +- src/ebay-star-rating-select/README.md | 5 +++-- src/ebay-star-rating/README.md | 5 +++-- src/ebay-svg/README.md | 2 +- src/ebay-switch/README.md | 6 ++++-- src/ebay-tabs/README.md | 4 ++-- src/ebay-textbox/README.md | 5 ++--- src/ebay-toast-dialog/README.md | 3 +++ src/ebay-tooltip/README.md | 5 ++--- src/ebay-tourtip/README.md | 5 ++--- src/ebay-video/README.md | 8 ++++++-- 47 files changed, 106 insertions(+), 65 deletions(-) diff --git a/src/ebay-alert-dialog/README.md b/src/ebay-alert-dialog/README.md index 39d0894b..ba6e3ffc 100644 --- a/src/ebay-alert-dialog/README.md +++ b/src/ebay-alert-dialog/README.md @@ -1,5 +1,8 @@ # EbayAlertDialog +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-alert-dialog--default) + ## Usage ```react diff --git a/src/ebay-badge/README.md b/src/ebay-badge/README.md index edb11859..6e4f796b 100644 --- a/src/ebay-badge/README.md +++ b/src/ebay-badge/README.md @@ -1,7 +1,7 @@ -# ebay-badge +# EbayBadge ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-badge--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/graphics-icons-ebay-badge--default) ## Usage ``` diff --git a/src/ebay-breadcrumbs/README.md b/src/ebay-breadcrumbs/README.md index 84a7204f..372dd31f 100644 --- a/src/ebay-breadcrumbs/README.md +++ b/src/ebay-breadcrumbs/README.md @@ -1,7 +1,7 @@ # EbayBreadcrumbs ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-breadcrumbs--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/navigation-disclosure-ebay-breadcrumbs--default) ## Usage diff --git a/src/ebay-button/README.md b/src/ebay-button/README.md index 4af49542..13f56cc0 100644 --- a/src/ebay-button/README.md +++ b/src/ebay-button/README.md @@ -1,7 +1,7 @@ # EbayButton ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-button--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/buttons-ebay-button--default) ## Usage diff --git a/src/ebay-calendar/README.md b/src/ebay-calendar/README.md index 646fd17b..6b7576e4 100644 --- a/src/ebay-calendar/README.md +++ b/src/ebay-calendar/README.md @@ -1,5 +1,8 @@ # EbayCalendar +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/building-blocks-ebay-calendar--default) + ## Usage ### Import JS diff --git a/src/ebay-carousel/README.md b/src/ebay-carousel/README.md index 7e5ccf26..7be08924 100644 --- a/src/ebay-carousel/README.md +++ b/src/ebay-carousel/README.md @@ -1,5 +1,8 @@ # EbayCarousel +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/navigation-disclosure-ebay-carousel--continuous) + ## Usage ```react diff --git a/src/ebay-checkbox/README.md b/src/ebay-checkbox/README.md index 849fcd31..752231f1 100644 --- a/src/ebay-checkbox/README.md +++ b/src/ebay-checkbox/README.md @@ -1,7 +1,7 @@ -# ebay-checkbox +# EbayCheckbox ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-checkbox--default-checkbox-button) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/form-input-ebay-checkbox--default-checkbox-button) ## Usage ``` diff --git a/src/ebay-confirm-dialog/README.md b/src/ebay-confirm-dialog/README.md index 0437b9d7..6928a38b 100644 --- a/src/ebay-confirm-dialog/README.md +++ b/src/ebay-confirm-dialog/README.md @@ -1,5 +1,8 @@ # EbayConfirmDialog +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-confirm-dialog--default) + ## Usage ```react diff --git a/src/ebay-cta-button/README.md b/src/ebay-cta-button/README.md index b531b16f..5bbdbc04 100644 --- a/src/ebay-cta-button/README.md +++ b/src/ebay-cta-button/README.md @@ -1,7 +1,7 @@ # EbayCtaButton ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-cta-button--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/buttons-ebay-cta-button--default) ## Usage diff --git a/src/ebay-date-textbox/README.md b/src/ebay-date-textbox/README.md index ab6614b8..ee865aa1 100644 --- a/src/ebay-date-textbox/README.md +++ b/src/ebay-date-textbox/README.md @@ -1,5 +1,8 @@ # EbayDateTextbox +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/form-input-ebay-date-textbox--default) + ## Usage ### Import JS diff --git a/src/ebay-drawer-dialog/README.md b/src/ebay-drawer-dialog/README.md index 4110c29d..83ecdb93 100644 --- a/src/ebay-drawer-dialog/README.md +++ b/src/ebay-drawer-dialog/README.md @@ -1,5 +1,8 @@ # EbayDrawerDialog +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-drawer-dialog--default) + ## Usage ### Import JS diff --git a/src/ebay-eek/README.md b/src/ebay-eek/README.md index e202cda5..307a3d09 100644 --- a/src/ebay-eek/README.md +++ b/src/ebay-eek/README.md @@ -2,7 +2,7 @@ This component displays the current European Union Energy (EEK) rating of certain items that consume energy. ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-eek--standard) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/graphics-icons-ebay-eek--regular-a) ## Usage diff --git a/src/ebay-fake-menu-button/README.md b/src/ebay-fake-menu-button/README.md index d40bff58..f401ac8f 100644 --- a/src/ebay-fake-menu-button/README.md +++ b/src/ebay-fake-menu-button/README.md @@ -1,7 +1,7 @@ -# ebay-fake-menu-button +# EbayFakeMenuButton ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-fake-menu-button--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/buttons-ebay-fake-menu-button--default) ## Install diff --git a/src/ebay-fake-menu/README.md b/src/ebay-fake-menu/README.md index 9aa2c5e7..392bfd23 100644 --- a/src/ebay-fake-menu/README.md +++ b/src/ebay-fake-menu/README.md @@ -1,7 +1,7 @@ -# ebay-fake-menu +# EbayFakeMenu ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-fake-menu--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/building-blocks-ebay-fake-menu--default) ## Install ``` diff --git a/src/ebay-fake-tabs/README.md b/src/ebay-fake-tabs/README.md index 1be0bd95..6caf5882 100644 --- a/src/ebay-fake-tabs/README.md +++ b/src/ebay-fake-tabs/README.md @@ -1,7 +1,7 @@ -# ebay-fake-tabs +# EbayFakeTab ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-fake-tabs--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/navigation-disclosure-ebay-fake-tabs--default-tabs) ## Import JS ```jsx harmony diff --git a/src/ebay-field/README.md b/src/ebay-field/README.md index 9788bdc8..e594f440 100644 --- a/src/ebay-field/README.md +++ b/src/ebay-field/README.md @@ -1,7 +1,7 @@ -# ebay-field +# EbayField ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-field--default-inline) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/form-input-ebay-field--default-inline) ## Import JS ```jsx harmony diff --git a/src/ebay-fullscreen-dialog/README.md b/src/ebay-fullscreen-dialog/README.md index bc92f8ea..a9e1009b 100644 --- a/src/ebay-fullscreen-dialog/README.md +++ b/src/ebay-fullscreen-dialog/README.md @@ -1,5 +1,8 @@ # EbayFullscreenDialog +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-fullscreen-dialog--default) + ## Usage ```react diff --git a/src/ebay-icon-button/README.md b/src/ebay-icon-button/README.md index a9d39016..ce2fd3ea 100644 --- a/src/ebay-icon-button/README.md +++ b/src/ebay-icon-button/README.md @@ -2,7 +2,7 @@ This is a circular button with an icon only. ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-icon-button--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/buttons-ebay-icon-button--default) ## Usage diff --git a/src/ebay-icon/README.md b/src/ebay-icon/README.md index 0e964688..e7e1e740 100644 --- a/src/ebay-icon/README.md +++ b/src/ebay-icon/README.md @@ -1,6 +1,9 @@ -# ebay-icon +# EbayIcon The component will include the actual SVG markup in the HTML and then reference the chosen icon. +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-fullscreen-dialog--default) + ## Usage ```jsx import { EbayIcon } from '@ebay/ui-core-react/ebay-icon' diff --git a/src/ebay-infotip/README.md b/src/ebay-infotip/README.md index 6483b8f4..9376ff0c 100644 --- a/src/ebay-infotip/README.md +++ b/src/ebay-infotip/README.md @@ -1,8 +1,8 @@ -# ebay-infotip +# EbayInfotip ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-infotip--default-infotip) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/buttons-ebay-infotip--default) ## Import JS diff --git a/src/ebay-inline-notice/README.md b/src/ebay-inline-notice/README.md index 7538fc70..2713c12a 100644 --- a/src/ebay-inline-notice/README.md +++ b/src/ebay-inline-notice/README.md @@ -1,8 +1,8 @@ -# ebay-inline-notice +# EbayInlineNotice ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-inline-notice--confirmation-message) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/notices-tips-ebay-inline-notice--default) ## Use diff --git a/src/ebay-lightbox-dialog/README.md b/src/ebay-lightbox-dialog/README.md index 127aa18c..2127f2e0 100644 --- a/src/ebay-lightbox-dialog/README.md +++ b/src/ebay-lightbox-dialog/README.md @@ -1,5 +1,8 @@ # EbayLightboxDialog +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-lightbox-dialog--default) + ## Usage ```react diff --git a/src/ebay-listbox-button/README.md b/src/ebay-listbox-button/README.md index 0083e57f..4e6f6491 100644 --- a/src/ebay-listbox-button/README.md +++ b/src/ebay-listbox-button/README.md @@ -1,7 +1,7 @@ -# ebay-listbox-button +# EbayListboxButton ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-listbox-button--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/buttons-ebay-listbox-button--default) ## Import JS ```jsx harmony diff --git a/src/ebay-menu-button/README.md b/src/ebay-menu-button/README.md index 0031ca4e..a53e915f 100644 --- a/src/ebay-menu-button/README.md +++ b/src/ebay-menu-button/README.md @@ -1,7 +1,7 @@ -# ebay-menu-button +# EbayMenuButton ## Demo -[Storybook](https://pages.github.corp.ebay.com/React/ebayui-core-react/master/?path=/story/ebay-menu-button--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/buttons-ebay-menu-button--default) ## Install ``` diff --git a/src/ebay-menu/README.md b/src/ebay-menu/README.md index 56ca9ed0..1092b832 100644 --- a/src/ebay-menu/README.md +++ b/src/ebay-menu/README.md @@ -1,7 +1,7 @@ -# ebay-menu +# EbayMenu ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-menu--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/building-blocks-ebay-menu--default) ## Install ``` diff --git a/src/ebay-page-notice/README.md b/src/ebay-page-notice/README.md index ca2b0776..c2a8ce33 100644 --- a/src/ebay-page-notice/README.md +++ b/src/ebay-page-notice/README.md @@ -1,8 +1,7 @@ -# ebay-page-notice +# EbayPageNotice ## Demo - -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-page-notice--confirmation-message) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/notices-tips-ebay-page-notice--simple-usage) ## Import JS diff --git a/src/ebay-pagination/README.md b/src/ebay-pagination/README.md index 7692afcf..18a9cd18 100644 --- a/src/ebay-pagination/README.md +++ b/src/ebay-pagination/README.md @@ -1,5 +1,8 @@ # EbayPagination +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/navigation-disclosure-ebay-pagination--basic-links) + The `` is a tag used to create a pagination navigation. It will display up to 9 page links. If pagination doesn't fit the page it will adjust to the available width. diff --git a/src/ebay-panel-dialog/README.md b/src/ebay-panel-dialog/README.md index 3f6b5d40..c9642992 100644 --- a/src/ebay-panel-dialog/README.md +++ b/src/ebay-panel-dialog/README.md @@ -1,5 +1,8 @@ # EbayPanelDialog +## Demo +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-panel-dialog--default) + ## Usage ```react diff --git a/src/ebay-progress-bar/README.md b/src/ebay-progress-bar/README.md index 6831503b..dfbc1911 100644 --- a/src/ebay-progress-bar/README.md +++ b/src/ebay-progress-bar/README.md @@ -2,7 +2,7 @@ The progress bar gives an immediate, real-time visualisation of the current task completion status. The progress bar's value does not include its min, so giving a value <= min will set the value to min + 1. ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-progress-bar--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/progress-ebay-progress-bar--default) ## Usage diff --git a/src/ebay-progress-spinner/README.md b/src/ebay-progress-spinner/README.md index b154cd98..7dcd4a37 100644 --- a/src/ebay-progress-spinner/README.md +++ b/src/ebay-progress-spinner/README.md @@ -1,7 +1,7 @@ # EbayProgressSpinner ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-progress-spinner--default-large) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/progress-ebay-progress-spinner--default-small-large) ## Usage diff --git a/src/ebay-progress-stepper/README.md b/src/ebay-progress-stepper/README.md index 46ebb8cb..bba25f82 100644 --- a/src/ebay-progress-stepper/README.md +++ b/src/ebay-progress-stepper/README.md @@ -1,8 +1,7 @@ -# ebay-progress-stepper +# EbayProgressStepper ## Demo - -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-progress-stepper--default) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/progress-ebay-progress-stepper--default) ## Usage diff --git a/src/ebay-radio/README.md b/src/ebay-radio/README.md index 9d26065d..0c45d15a 100644 --- a/src/ebay-radio/README.md +++ b/src/ebay-radio/README.md @@ -1,7 +1,7 @@ -# ebay-radio +# EbayRadio ## Demo -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-radio--default-radio-button) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/form-input-ebay-radio--default) ## Install ``` diff --git a/src/ebay-section-notice/README.md b/src/ebay-section-notice/README.md index 61b271a7..93665bc6 100644 --- a/src/ebay-section-notice/README.md +++ b/src/ebay-section-notice/README.md @@ -1,8 +1,7 @@ -# ebay-section-notice +# EbaySectionNotice ## Demo - -[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-section-notice--default-message-with-no-action) +[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/notices-tips-ebay-section-notice--default-message-with-no-action) ## Import JS diff --git a/src/ebay-select/README.md b/src/ebay-select/README.md index 9e0ceaa8..922ac14e 100644 --- a/src/ebay-select/README.md +++ b/src/ebay-select/README.md @@ -2,7 +2,7 @@ This component is used to create a native `