Skip to content

Commit

Permalink
docs: fix broken docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
nuria1110 committed Jan 27, 2025
1 parent 4311584 commit a228d85
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 23 deletions.
2 changes: 1 addition & 1 deletion src/components/box/box.component.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
6 changes: 3 additions & 3 deletions src/components/checkbox/checkbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions src/components/confirm/confirm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 2 additions & 0 deletions src/components/date-range/date-range.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

<Canvas of={DateRangeStories.DefaultStory} />
Expand Down
8 changes: 0 additions & 8 deletions src/components/definition-list/definition-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import * as DefinitionListStories from "./definition-list.stories";
## Contents

- [Quick Start](#quick-start)
- [Related Components](#related-components)
- [Examples](#examples)
- [Props](#props)

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/components/settings-row/settings-row.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion src/components/split-button/split-button.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
8 changes: 4 additions & 4 deletions src/components/switch/switch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion src/components/tabs/tabs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down

0 comments on commit a228d85

Please sign in to comment.