Skip to content

Commit c4047b3

Browse files
authored
Use description and title front matter for pages rendered from /content (#6832)
1 parent 13832f7 commit c4047b3

File tree

127 files changed

+162
-683
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+162
-683
lines changed

.changeset/fair-owls-hug.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'polaris.shopify.com': patch
3+
---
4+
5+
Use description and title front matter for pages rendered from /content

polaris.shopify.com/content/components/account-connection/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Account connection
3+
description: The account connection component is used so merchants can connect or disconnect their store to various accounts. For example, if merchants want to use the Facebook sales channel, they need to connect their Facebook account to their Shopify store.
34
category: Actions
45
keywords:
56
- AccountConnection
@@ -19,12 +20,6 @@ examples:
1920
description: Use to let merchants connect or disconnect their store to their third-party accounts, like Facebook.
2021
---
2122

22-
# Account connection
23-
24-
The account connection component is used so merchants can connect or disconnect their store to various accounts. For example, if merchants want to use the Facebook sales channel, they need to connect their Facebook account to their Shopify store.
25-
26-
---
27-
2823
## Best practices
2924

3025
The account component should:

polaris.shopify.com/content/components/action-list/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Action list
3+
description: Action lists render a list of actions or selectable options. This component is usually placed inside a [popover container](https://polaris.shopify.com/components/popover) to create a dropdown menu or to let merchants select from a list of options.
34
category: Actions
45
keywords:
56
- ActionList
@@ -35,12 +36,6 @@ examples:
3536
description: Use help text when the normal Verb noun syntax for the actions does not provide sufficient context for the merchant.
3637
---
3738

38-
# Action list
39-
40-
Action lists render a list of actions or selectable options. This component is usually placed inside a [popover container](https://polaris.shopify.com/components/popover) to create a dropdown menu or to let merchants select from a list of options.
41-
42-
---
43-
4439
## Best practices
4540

4641
Actions lists should:

polaris.shopify.com/content/components/app-provider/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: App provider
3+
description: App provider is a required component that enables sharing global settings throughout the hierarchy of your application.
34
category: Structure
45
keywords:
56
- app
@@ -29,12 +30,6 @@ examples:
2930
description: With a `colorScheme`, the app provider component will set the root color scheme for the App (such as light or dark). For `colorScheme` configuration, see the [CustomProperties](https://polaris.shopify.com/components/custom-properties) component documentation.
3031
---
3132

32-
# App provider
33-
34-
App provider is a required component that enables sharing global settings throughout the hierarchy of your application.
35-
36-
---
37-
3833
## Best practices
3934

4035
The app provider component is required to use Polaris. Without it, the components in your application will not function correctly. You must wrap the root (the top) of your application in the app provider component.

polaris.shopify.com/content/components/autocomplete/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Autocomplete
3+
description: The autocomplete component is an input field that provides selectable suggestions as a merchant types into it. It allows merchants to quickly search through and select from large collections of options. It's a convenience wrapper around the `Combobox` and `Listbox` components with minor UI differences.
34
category: Forms
45
keywords:
56
- autocomplete
@@ -36,12 +37,6 @@ examples:
3637
description: Use to help merchants complete a destructive action quickly.
3738
---
3839

39-
# Autocomplete
40-
41-
The autocomplete component is an input field that provides selectable suggestions as a merchant types into it. It allows merchants to quickly search through and select from large collections of options. It's a convenience wrapper around the `Combobox` and `Listbox` components with minor UI differences.
42-
43-
---
44-
4540
## Best practices
4641

4742
The autocomplete component should:

polaris.shopify.com/content/components/avatar/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Avatar
3+
description: Avatars are used to show a thumbnail representation of an individual or business in the interface.
34
category: Images and icons
45
keywords:
56
- photo
@@ -29,12 +30,6 @@ examples:
2930
description: Use a `square` shape when the avatar represents a non-person entity like an app, channel, or store.
3031
---
3132

32-
# Avatar
33-
34-
Avatars are used to show a thumbnail representation of an individual or business in the interface.
35-
36-
---
37-
3833
## Best practices
3934

4035
Avatars should be one of 4 sizes:

polaris.shopify.com/content/components/badge/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Badge
3+
description: Badges are used to inform merchants of the status of an object or of an action that’s been taken.
34
category: Images and icons
45
keywords:
56
- pills
@@ -49,12 +50,6 @@ examples:
4950
description: Use when the status and progress accessibilityLabels are not appropriate to a given context.
5051
---
5152

52-
# Badge
53-
54-
Badges are used to inform merchants of the status of an object or of an action that’s been taken.
55-
56-
---
57-
5853
## Best practices
5954

6055
Badges benefit merchants by:

polaris.shopify.com/content/components/banner/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Banner
3+
description: Informs merchants about important changes or persistent conditions. Use this component if you need to communicate to merchants in a prominent way. Banners are placed at the top of the page or section they apply to, and below the page or section header.
34
category: Feedback indicators
45
keywords:
56
- inform
@@ -56,12 +57,6 @@ examples:
5657
description: Banners inside of cards render with less spacing and a pared-back design to fit within a content context.
5758
---
5859

59-
# Banner
60-
61-
Informs merchants about important changes or persistent conditions. Use this component if you need to communicate to merchants in a prominent way. Banners are placed at the top of the page or section they apply to, and below the page or section header.
62-
63-
---
64-
6560
## Best practices
6661

6762
Banners should:

polaris.shopify.com/content/components/button-group/index.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Button group
3+
description: Button group displays multiple related actions stacked or in a horizontal row to help with arrangement and spacing.
34
category: Actions
45
keywords:
56
- ButtonGroup
@@ -29,12 +30,6 @@ examples:
2930
description: Use to emphasize several buttons as a thematically-related set among other controls.
3031
---
3132

32-
# Button group
33-
34-
Button group displays multiple related actions stacked or in a horizontal row to help with arrangement and spacing.
35-
36-
---
37-
3833
## Best practices
3934

4035
Button groups should:

polaris.shopify.com/content/components/button/index.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Button
3+
description: Buttons are used primarily for actions, such as “Add”, “Close”, “Cancel”, or “Save”. Plain buttons, which look similar to links, are used for less important or less commonly used actions, such as “view shipping settings”.
34
category: Actions
45
keywords:
56
- CTA
@@ -80,14 +81,6 @@ examples:
8081
description: Use when a button has been pressed and the associated action is in progress.
8182
---
8283

83-
# Button
84-
85-
Buttons are used primarily for actions, such as “Add”, “Close”, “Cancel”, or “Save”. Plain buttons, which look similar to links, are used for less important or less commonly used actions, such as “view shipping settings”.
86-
87-
For navigational actions that appear within or directly following a sentence, use the [link component](https://polaris.shopify.com/components/link).
88-
89-
---
90-
9184
## Best practices
9285

9386
Buttons should:

0 commit comments

Comments
 (0)