From a228d85df59ee0502bb6a0826391cba7746228cd Mon Sep 17 00:00:00 2001 From: nuria1110 Date: Mon, 27 Jan 2025 15:57:31 +0000 Subject: [PATCH] docs: fix broken docs links --- src/components/box/box.component.tsx | 2 +- src/components/checkbox/checkbox.mdx | 6 +++--- src/components/confirm/confirm.mdx | 8 ++++---- src/components/date-range/date-range.mdx | 2 ++ src/components/definition-list/definition-list.mdx | 8 -------- src/components/settings-row/settings-row.mdx | 2 +- src/components/split-button/split-button.mdx | 1 - src/components/switch/switch.mdx | 8 ++++---- src/components/tabs/tabs.mdx | 1 - 9 files changed, 15 insertions(+), 23 deletions(-) diff --git a/src/components/box/box.component.tsx b/src/components/box/box.component.tsx index d6e56f9d41..b475d7f977 100644 --- a/src/components/box/box.component.tsx +++ b/src/components/box/box.component.tsx @@ -61,7 +61,7 @@ export interface BoxProps rowGap?: Gap; /** Design Token for Box Shadow. Note: please check that the box shadow design token you are using is compatible with the Box component. */ boxShadow?: BoxShadowsType; - /** Design Token for Border Radius. Note: please check that the border radius design token you are using is compatible with the Box component. **This prop will not do anything if you have the roundedCornerOptOut flag set in the CarbonProvider** */ + /** Design Token for Border Radius. Note: please check that the border radius design token you are using is compatible with the Box component. */ borderRadius?: BorderRadiusType; /** @private @ignore */ className?: string; diff --git a/src/components/checkbox/checkbox.mdx b/src/components/checkbox/checkbox.mdx index f7e086a4a3..87a2fc9efe 100644 --- a/src/components/checkbox/checkbox.mdx +++ b/src/components/checkbox/checkbox.mdx @@ -41,9 +41,9 @@ import { Checkbox, CheckboxGroup } from "carbon-react/lib/components/checkbox"; ## Related Components -- 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"). +- Choosing one option from a longer list? [Try Radio Button](../?path=/docs/radio-button--docs). +- Choosing one option from a very long list? [Try Select](../?path=/docs/select--docs). +- Choosing one option from a highly visible range? [Try Button Toggle](../?path=/docs/button-toggle--docs). ## Examples diff --git a/src/components/confirm/confirm.mdx b/src/components/confirm/confirm.mdx index 577bd562c1..4470da5f79 100644 --- a/src/components/confirm/confirm.mdx +++ b/src/components/confirm/confirm.mdx @@ -26,10 +26,10 @@ import Confirm from "carbon-react/lib/components/confirm"; ## Related Components -- 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"). +- Longer message which stays on-screen? [Try Message](../?path=/docs/message--docs). +- Longer, time sensitive message that must be dismissed? [Try Toast](../?path=/docs/toast--docs). +- Error or warning message that interrupts activity? [Try Alert](../?path=/docs/alert--docs). +- Simple task in context? [Try Dialog](../?path=/docs/dialog--docs). ## Examples diff --git a/src/components/date-range/date-range.mdx b/src/components/date-range/date-range.mdx index 1489b9cf26..8376426314 100644 --- a/src/components/date-range/date-range.mdx +++ b/src/components/date-range/date-range.mdx @@ -33,6 +33,8 @@ Used to filter a Table of data according to a start and end date, or to set two import DateRange from "carbon-react/lib/components/date-range"; ``` +## Examples + ### Default diff --git a/src/components/definition-list/definition-list.mdx b/src/components/definition-list/definition-list.mdx index 275ba3b30d..c66bd1153e 100644 --- a/src/components/definition-list/definition-list.mdx +++ b/src/components/definition-list/definition-list.mdx @@ -11,7 +11,6 @@ import * as DefinitionListStories from "./definition-list.stories"; ## Contents - [Quick Start](#quick-start) -- [Related Components](#related-components) - [Examples](#examples) - [Props](#props) @@ -21,13 +20,6 @@ import * as DefinitionListStories from "./definition-list.stories"; import { Dl, Dt, Dd } from "carbon-react/lib/components/definition-list"; ``` -## Related Components - -Definition List most of the time is in use with other components. Look at the examples below - -- [Tile component with Definition List](/?path=/docs/tile--with-definition-list-default "Tile component with Definition List"). -- [Accordion component with Definition List](/?path=/docs/accordion--with-a-definition-list "Accordion component with Definition List"). - ## Examples ### Default diff --git a/src/components/settings-row/settings-row.mdx b/src/components/settings-row/settings-row.mdx index 5cf3866c39..7ee13c253a 100644 --- a/src/components/settings-row/settings-row.mdx +++ b/src/components/settings-row/settings-row.mdx @@ -22,7 +22,7 @@ A good example is a settings page, or step-by-step wizard. import SettingsRow from "carbon-react/lib/components/settings-row"; ``` -## Example +## Examples ### Default diff --git a/src/components/split-button/split-button.mdx b/src/components/split-button/split-button.mdx index 8e6b08c2a9..efe0fc17e8 100644 --- a/src/components/split-button/split-button.mdx +++ b/src/components/split-button/split-button.mdx @@ -21,7 +21,6 @@ import * as SplitButtonStories from "./split-button.stories"; ## Contents - [Quick Start](#quick-start) -- [Related Components](#related-components) - [Examples](#examples) - [Props](#props) - [Translation keys](#translation-keys) diff --git a/src/components/switch/switch.mdx b/src/components/switch/switch.mdx index 3f144a753e..6d02e899d1 100644 --- a/src/components/switch/switch.mdx +++ b/src/components/switch/switch.mdx @@ -38,10 +38,10 @@ import Switch from "carbon-react/lib/components/switch"; ## Related Components -- 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"). +- Choosing more than one option? [Try Checkbox](../?path=/docs/checkbox--docs). +- Choosing one option from a longer list? [Try Radio Button](../?path=/docs/radio-button--docs). +- Choosing one option from a very long list? [Try Select](../?path=/docs/select--docs). +- Choosing one option from a highly visible range? [Try Button Toggle](../?path=/docs/button-toggle--docs). ## Translations diff --git a/src/components/tabs/tabs.mdx b/src/components/tabs/tabs.mdx index 9271fda842..6367dc76e2 100644 --- a/src/components/tabs/tabs.mdx +++ b/src/components/tabs/tabs.mdx @@ -21,7 +21,6 @@ Switch between content panes or filtered views of tables. ## Contents - [Quick Start](#quick-start) -- [Related Components](#related-components) - [Examples](#examples) - [Props](#props)