Skip to content

Commit

Permalink
Merge pull request #6277 from Sage/update_related_comps_paths
Browse files Browse the repository at this point in the history
docs: update incorrect paths for related components
  • Loading branch information
edleeks87 authored Aug 29, 2023
2 parents c6d95f1 + b53ae09 commit c9746eb
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 28 deletions.
4 changes: 2 additions & 2 deletions docs/using-draft-js.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
* [Useful Links](#useful-links)

## Installation
The [TextEditor](https://carbon.sage.com/?path=/docs/text-editor--default-story) and
[Note](https://carbon.sage.com/?path=/docs/note--default-story) components utilise the `Draft.js` framework to
The [TextEditor](https://carbon.sage.com/?path=/docs/text-editor--default) and
[Note](https://carbon.sage.com/?path=/docs/note--default) components utilise the `Draft.js` framework to
support creating and rendering rich-text content. As such, the framework has been added as a peer-dependency and
consuming projects are required to install it if they wish to use either component, this can be done as an
[npm package](https://www.npmjs.com/package/draft-js).
Expand Down
8 changes: 4 additions & 4 deletions src/components/alert/alert.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ import Alert from "carbon-react/lib/components/alert";

## Related Components

- Longer message which stays on-screen? [Try Message](/?path=/docs/message--default-story "Try Message").
- Longer, time sensitive message that must be dismissed? [Try Toast](/?path=/docs/toast--default-story "Try Toast").
- Confirm or cancel an action I’ve initiated? [Try Confirm](/?path=/docs/confirm--default-story "Try Confirm").
- Simple task in context? [Try Dialog](/?path=/docs/dialog--default-story "Try Dialog").
- Longer message which stays on-screen? [Try Message](https://carbon.sage.com/?path=/docs/message--default "Try Message").
- Longer, time sensitive message that must be dismissed? [Try Toast](https://carbon.sage.com/?path=/docs/toast--default "Try Toast").
- Confirm or cancel an action I’ve initiated? [Try Confirm](https://carbon.sage.com/?path=/docs/confirm--default-story "Try Confirm").
- Simple task in context? [Try Dialog](https://carbon.sage.com/?path=/docs/dialog--default-story "Try Dialog").

## Examples

Expand Down
6 changes: 3 additions & 3 deletions src/components/checkbox/checkbox.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ import { Checkbox } from "carbon-react/lib/components/checkbox";

## Related Components

- Choosing one option from a longer list? [Try Radio Button](/?path=/docs/experimental-radiobutton--default "Radio Button").
- Choosing one option from a very long list? [Try Select](?path=/docs/select--default-story "Select").
- Choosing one option from a highly visible range? [Try Button Toggle](/?path=/story/button-toggle--default "Button Toggle").
- Choosing one option from a longer list? [Try Radio Button](https://carbon.sage.com/?path=/docs/radiobutton--default "Radio Button").
- Choosing one option from a very long list? [Try Select](https://carbon.sage.com/?path=/docs/select--default "Select").
- Choosing one option from a highly visible range? [Try Button Toggle](https://carbon.sage.com/?path=/docs/button-toggle--default "Button Toggle").

## Examples

Expand Down
8 changes: 4 additions & 4 deletions src/components/confirm/confirm.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,10 @@ import Confirm from "carbon-react/lib/components/confirm";

## Related Components

- Longer message which stays on-screen? [Try Message](/?path=/docs/message--default-story "Message").
- Longer, time sensitive message that must be dismissed? [Try Toast](/?path=/docs/toast--default-story "Toast").
- Error or warning message that interrupts activity? [Try Alert](/?path=/docs/alert--default-story "Alert").
- Simple task in context? [Try Dialog](/?path=/docs/dialog--default-story "Dialog").
- Longer message which stays on-screen? [Try Message](https://carbon.sage.com/?path=/docs/message--default "Message").
- Longer, time sensitive message that must be dismissed? [Try Toast](https://carbon.sage.com/?path=/docs/toast--default "Toast").
- Error or warning message that interrupts activity? [Try Alert](https://carbon.sage.com/?path=/docs/alert--default-alert "Alert").
- Simple task in context? [Try Dialog](https://carbon.sage.com/?path=/docs/dialog--default-story "Dialog").

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ import DialogFullScreen from "carbon-react/lib/components/dialog-full-screen";

## Related Components

- Simple task in context? [Try Dialog](/?path=/docs/dialog--default-story "Dialog").
- Need to refer back to the underlying page? [Try Sidebar](/?path=/docs/sidebar--default-story "Sidebar").
- Simple task in context? [Try Dialog](https://carbon.sage.com/?path=/docs/dialog--default-story "Dialog").
- Need to refer back to the underlying page? [Try Sidebar](https://carbon.sage.com/?path=/docs/sidebar--default-story "Sidebar").

## Examples

Expand Down
4 changes: 2 additions & 2 deletions src/components/dialog/dialog.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ import Dialog from "carbon-react/lib/components/dialog";

## Related Components

- Complex task that needs more space? [Try Dialog Full Screen](/?path=/docs/dialog-full-screen--default-story "Dialog Full Screen").
- Need to refer back to the underlying page? [Try Sidebar](/?path=/docs/sidebar--default-story "Sidebar").
- Complex task that needs more space? [Try Dialog Full Screen](https://carbon.sage.com/?path=/docs/dialog-full-screen--default "Dialog Full Screen").
- Need to refer back to the underlying page? [Try Sidebar](https://carbon.sage.com/?path=/docs/sidebar--default-story "Sidebar").

## Examples

Expand Down
4 changes: 2 additions & 2 deletions src/components/message/message.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ Various types are available:

## Related Components

- Longer, time sensitive message that must be dismissed? [Try Toast](/?path=/docs/toast--default-story "Toast").
- Error or warning message that interrupts activity? [Try Alert](/?path=/docs/alert--default-story "Alert").
- Longer, time sensitive message that must be dismissed? [Try Toast](https://carbon.sage.com/?path=/docs/toast--default "Toast").
- Error or warning message that interrupts activity? [Try Alert](https://carbon.sage.com/?path=/docs/alert--default-alert "Alert").

## Examples

Expand Down
6 changes: 3 additions & 3 deletions src/components/show-edit-pod/show-edit-pod.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ import ShowEditPod from "carbon-react/lib/components/show-edit-pod";

## Related Components

- Editing a number of closely related inputs? [Try Fieldset](/?path=/docs/fieldset-address-fieldset-examples--canada "Fieldset").
- Filling in a broad series of inputs? [Try Form](/?path=/docs/form--default-with-sticky-footer "Form").
- Viewing content that’s grouped together visually? [Try Pod](/?path=/docs/pod--default-story "Pod").
- Editing a number of closely related inputs? [Try Fieldset](https://carbon.sage.com/?path=/docs/fieldset-address-fieldset-examples--canada "Fieldset").
- Filling in a broad series of inputs? [Try Form](https://carbon.sage.com/?path=/docs/form--default-with-sticky-footer "Form").
- Viewing content that’s grouped together visually? [Try Pod](https://carbon.sage.com/?path=/docs/pod--default "Pod").

## Examples

Expand Down
4 changes: 2 additions & 2 deletions src/components/sidebar/sidebar.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ import Sidebar from "carbon-react/lib/components/sidebar";

## Related Components

- Simple task in context? [Try Dialog](/?path=/docs/dialog--default-story "Try Dialog").
- Complex task that needs more space? [Try Dialog Full Screen](/?path=/docs/dialog-full-screen--default-story "Try Dialog Full Screen").
- Simple task in context? [Try Dialog](https://carbon.sage.com/?path=/docs/dialog--default-story "Try Dialog").
- Complex task that needs more space? [Try Dialog Full Screen](https://carbon.sage.com/?path=/docs/dialog-full-screen--default "Try Dialog Full Screen").

## Examples

Expand Down
8 changes: 4 additions & 4 deletions src/components/switch/switch.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ import Switch from "carbon-react/lib/components/switch";

## Related Components

- Choosing more than one option? [Try Checkbox](/?path=/docs/experimental-checkbox--default-story "Checkbox").
- Choosing one option from a longer list? [Try Radio Button](/?path=/docs/experimental-radiobutton--default "Radio Button").
- Choosing one option from a very long list? [Try Select](?path=/docs/select--default-story "Select").
- Choosing one option from a highly visible range? [Try Button Toggle](/?path=/story/button-toggle--default "Button Toggle").
- Choosing more than one option? [Try Checkbox](https://carbon.sage.com/?path=/docs/checkbox--default "Checkbox").
- Choosing one option from a longer list? [Try Radio Button](https://carbon.sage.com/?path=/docs/radiobutton--default "Radio Button").
- Choosing one option from a very long list? [Try Select](https://carbon.sage.com/?path=/docs/select--default "Select").
- Choosing one option from a highly visible range? [Try Button Toggle](https://carbon.sage.com/?path=/docs/button-toggle--default "Button Toggle").

## Translations

Expand Down

0 comments on commit c9746eb

Please sign in to comment.