Skip to content

Commit

Permalink
fix storybook urls and improve docs (#2268)
Browse files Browse the repository at this point in the history
Co-authored-by: Cole Bemis <colebemis@github.com>
  • Loading branch information
broccolinisoup and colebemis committed Aug 25, 2022
1 parent 8fc2e42 commit 7b8bc81
Show file tree
Hide file tree
Showing 7 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/content/Autocomplete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Autocomplete
status: Alpha
description: Used to render a text input that allows a user to quickly filter through a list of options to pick one or more values.
source: https://github.com/primer/react/tree/main/src/Autocomplete
storybook: '/react/storybook?path=/story/form-controls-autocomplete--default'
storybook: '/react/storybook?path=/story/forms-form-controls-autocomplete'
---

import {Autocomplete} from '@primer/react'
Expand Down
2 changes: 1 addition & 1 deletion docs/content/Checkbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Checkbox
description: Use checkboxes to toggle between checked and unchecked states in a list or as a standalone form field
status: Alpha
source: https://github.com/primer/react/blob/main/src/Checkbox.tsx
storybook: '/react/storybook?path=/story/form-controls-checkbox--default'
storybook: '/react/storybook?path=/story/forms-form-controls-checkbox'
componentId: checkbox
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/CheckboxGroup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ componentId: checkbox_group
description: Renders a set of checkboxes to let users make one or more selections from a short list of options
status: Alpha
source: https://github.com/primer/react/blob/main/src/CheckboxGroup/CheckboxGroup.tsx
storybook: '/react/storybook/?path=/story/forms-checkboxgroup-examples--basic'
storybook: '/react/storybook/?path=/story/forms-checkboxgroup-examples'
---

import {CheckboxGroup, Checkbox, Box} from '@primer/components'
Expand Down
12 changes: 6 additions & 6 deletions docs/content/FilteredSearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: FilteredSearch
status: Alpha
---

The FilteredSearch component helps style a Dropdown and a TextInput side-by-side.
The FilteredSearch component helps style an ActionMenu and a TextInput side-by-side.

**Note:** You _must_ use a `TextInput` and `Dropdown` (or native `<details>` and `<summary>`) in order for this component to work properly.
**Note:** You _must_ use a `TextInput` and `ActionMenu` (or native `<details>` and `<summary>`) in order for this component to work properly.

## Default example

Expand All @@ -30,7 +30,7 @@ The FilteredSearch component helps style a Dropdown and a TextInput side-by-side

#### FilteredSearch.Children

| Name | Type | Default | Description |
| :------- | :---------------- | :-----: | :------------------------------------------------------------------------------------------------------- |
| children | | | FilteredSearch is expected to contain a [`Dropdown`](/Dropdown) followed by a [`TextInput`](/TextInput). |
| sx | SystemStyleObject | {} | Style to be applied to the component |
| Name | Type | Default | Description |
| :------- | :---------------- | :-----: | :------------------------------------------------------------------------------------------------------------ |
| children | | | FilteredSearch is expected to contain an [`ActionMenu`](/ActionMenu) followed by a [`TextInput`](/TextInput). |
| sx | SystemStyleObject | {} | Style to be applied to the component |
2 changes: 1 addition & 1 deletion docs/content/IconButton.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: IconButton
componentId: icon_button
status: Alpha
source: https://github.com/primer/react/tree/main/src/Button
storybook: '/react/storybook?path=/story/composite-components-button'
storybook: '/react/storybook?path=/story/composite-components-button--icon-button'
description: An accessible button component with no text and only icon.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/Label.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Label
componentId: label
status: Alpha
source: https://github.com/primer/react/tree/main/src/Label
storybook: '/react/storybook?path=story/labels-label--label'
storybook: '/react/storybook?path=/story/labels-label--label'
description: Use Label components to add contextual metadata to a design.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/PageLayout.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {PageLayout} from '@primer/react'

<Note>

See [storybook](https://primer.style/react/storybook?path=/story/layout-pagelayout--playground) for fullscreen examples.
See [storybook](https://primer.style/react/storybook?path=/story/layout-pagelayout) for fullscreen examples.

</Note>

Expand Down

0 comments on commit 7b8bc81

Please sign in to comment.