Skip to content

Commit

Permalink
docs: Adds Missing or Wrong Storybook Demo Links (#343)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
calebnance authored May 17, 2024
1 parent f8f9f1d commit 6763494
Show file tree
Hide file tree
Showing 47 changed files with 106 additions and 65 deletions.
3 changes: 3 additions & 0 deletions src/ebay-alert-dialog/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# EbayAlertDialog

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-alert-dialog--default)

## Usage

```react
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-badge/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down
2 changes: 1 addition & 1 deletion src/ebay-breadcrumbs/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ebay-button/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
3 changes: 3 additions & 0 deletions src/ebay-calendar/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/ebay-carousel/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# EbayCarousel

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/navigation-disclosure-ebay-carousel--continuous)

## Usage

```react
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-checkbox/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down
3 changes: 3 additions & 0 deletions src/ebay-confirm-dialog/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# EbayConfirmDialog

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-confirm-dialog--default)

## Usage

```react
Expand Down
2 changes: 1 addition & 1 deletion src/ebay-cta-button/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
3 changes: 3 additions & 0 deletions src/ebay-date-textbox/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/ebay-drawer-dialog/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/ebay-eek/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/ebay-fake-menu-button/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-fake-menu/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-fake-tabs/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-field/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 3 additions & 0 deletions src/ebay-fullscreen-dialog/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# EbayFullscreenDialog

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-fullscreen-dialog--default)

## Usage

```react
Expand Down
2 changes: 1 addition & 1 deletion src/ebay-icon-button/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 4 additions & 1 deletion src/ebay-icon/README.md
Original file line number Diff line number Diff line change
@@ -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'
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-infotip/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/ebay-inline-notice/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
3 changes: 3 additions & 0 deletions src/ebay-lightbox-dialog/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# EbayLightboxDialog

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-lightbox-dialog--default)

## Usage

```react
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-listbox-button/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-menu-button/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-menu/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down
5 changes: 2 additions & 3 deletions src/ebay-page-notice/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
3 changes: 3 additions & 0 deletions src/ebay-pagination/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# EbayPagination

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/navigation-disclosure-ebay-pagination--basic-links)

The `<EbayPagination>` 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.

Expand Down
3 changes: 3 additions & 0 deletions src/ebay-panel-dialog/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# EbayPanelDialog

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-panel-dialog--default)

## Usage

```react
Expand Down
2 changes: 1 addition & 1 deletion src/ebay-progress-bar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ebay-progress-spinner/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
5 changes: 2 additions & 3 deletions src/ebay-progress-stepper/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
4 changes: 2 additions & 2 deletions src/ebay-radio/README.md
Original file line number Diff line number Diff line change
@@ -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
```
Expand Down
5 changes: 2 additions & 3 deletions src/ebay-section-notice/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/ebay-select/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
This component is used to create a native `<select>` form element with default browser styling.

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-select--default)
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/form-input-ebay-select--basic)

## Import JS
```jsx harmony
Expand Down
4 changes: 2 additions & 2 deletions src/ebay-signal/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# ebay-signal
# EbaySignal

##Description
Signals are data-backed recommendations to help customers make more informed decisions. There are four signal statuses, each corresponding to a specific color: `trustworthy`, `recent`, `time-sensitive` & `neutral`. Defaults to `neutral` if none specified.

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-signal)
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/graphics-icons-ebay-signal--default-case)

## Usage
```
Expand Down
3 changes: 3 additions & 0 deletions src/ebay-snackbar-dialog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ The user usually will want to manage the state of the snackbar, and so should pr

In the case where the application developer only wants to manage the initial state of the snackbar, the dev can choose to provide only the open state as a boolean. This is useful when a dev wants the snackbar to appear only once on initial render and then disappear.

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/dialogs-ebay-snackbar-dialog--default)

## Import JS
```jsx harmony
import { EbaySnackbarDialog, EbaySnackbarDialogAction } from '@ebay/ui-core-react/ebay-snackbar-dialog';
Expand Down
2 changes: 1 addition & 1 deletion src/ebay-split-button/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# EbaySplitButton

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-split-button--default)
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/buttons-ebay-split-button--controls)

## Usage

Expand Down
5 changes: 3 additions & 2 deletions src/ebay-star-rating-select/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# ebay-star-rating-select
# EbayStarRatingSelect
use (rating from 0-5)

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-star-rating-select--isolated)
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/form-input-ebay-star-rating-select--isolated)

## Usage
```
Expand Down
5 changes: 3 additions & 2 deletions src/ebay-star-rating/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# ebay-star-rating
# EbayStarRating
For full stars use (rating from 0-5): ebay-star-rating-{rating} For half stars use: ebay-star-rating-{rating}-5 DS v1.0.0

## Demo
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/ebay-star-rating--dynamic-stars)
[Storybook](https://opensource.ebay.com/ebayui-core-react/main/?path=/story/graphics-icons-ebay-star-rating--stars)

## Usage
```
Expand Down
2 changes: 1 addition & 1 deletion src/ebay-svg/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ebay-svg
# EbaySvg
This is a helper component which holds all the SVG icons for your other `@ebay/ui-core-react` components.

## Install
Expand Down
Loading

0 comments on commit 6763494

Please sign in to comment.