Skip to content

Commit 25f245f

Browse files
authored
Content design page updates (#13143)
<!-- ☝️How to write a good PR title: - Prefix it with [ComponentName] (if applicable), for example: [Button] - Start with a verb, for example: Add, Delete, Improve, Fix… - Give as much context as necessary and as little as possible - Open it as a draft if it’s a work in progress --> This PR is a follow up to #13012 to make small content changes to the polaris.shopify.com and add a few redirects. ### WHY are these changes introduced? - Small editorial udates to a few pages - Updated page and section titles - Added missing redirect to account for deleted page. ### WHAT is this pull request doing? - Content changes - Update to redirects ### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#install-dependencies-and-build-workspaces) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog) ### 🎩 checklist - [x] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [x] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [x] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide
1 parent ed2ac63 commit 25f245f

File tree

10 files changed

+26
-14
lines changed

10 files changed

+26
-14
lines changed

.changeset/gentle-cycles-teach.md

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

polaris.shopify.com/content/content/alternative-text.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Alternative text
3-
description: Alt text provides an inclusive experience for merchants who use screen readers.
3+
description: Build inclusive experiences for merchants who use screen readers
44
icon: ImageAltIcon
55
order: 5
66
keywords:

polaris.shopify.com/content/content/error-messages.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Error messages should:
2626
- Help merchants avoid mistakes in the first place, using clear content to manage expectations and highlight potential risks
2727
- Only explain what happened behind the scenes when it’s helpful to merchants or you can’t offer a solution
2828

29-
As always, follow all our content principles of keeping it short, using plain language, and getting rid of repetition. Also, good design can reduce the need for error messages by preventing them.
29+
As always, follow our content [fundamentals](/content/fundamentals) of keeping it short, using plain language, and getting rid of repetition.
3030

3131
## Design for clarity
3232

@@ -114,13 +114,13 @@ Button: Shopify Home
114114
#### Do
115115

116116
Heading: Couldn’t deposit payout \
117-
Body: The bank account we have on file was closed. Update your details, and we’ll retry automatically.
117+
Body: The bank account we have on file was closed. Update your details, and we’ll retry automatically. \
118118
Button: Update bank account
119119

120120
#### Don’t
121121

122-
Heading: Invalid bank account
123-
Body: Your payout was not deposited because your bank account was closed. Go to your bank account details and update them to match a valid checking account. Then save so that we can retry.
122+
Heading: Invalid bank account \
123+
Body: Your payout was not deposited because your bank account was closed. Go to your bank account details and update them to match a valid checking account. Then save so that we can retry. \
124124
Button: Next
125125

126126

polaris.shopify.com/content/content/fundamentals.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Fundamentals
3-
description: How to design content to create world-class software
3+
description: Designing content for experiences
44
icon: TextInColumnsIcon
55
order: 1
66
keywords:
@@ -36,7 +36,7 @@ keywords:
3636

3737
These fundamentals apply to every piece of content you create. For specific questions, dig into our detailed content guidelines for everything from [grammar](/content/grammar-and-mechanics) to [components](/components).
3838

39-
Think of tools you use every day, such as your phone, car, blender. They all have a learning curve. But the very best of them feel easy from the very first use. Buttons are where you expect them. Labeling is intuitive. Everything unnecessary has been removed, and what’s left is the perfect balance of words and visuals. That’s what we’re building here at Shopify.
39+
Think of tools you use every day, such as your phone, car, or blender. They all have a learning curve, but the very best of them feel easy from the very first use. Buttons are where you expect them. Labeling is intuitive. Everything unnecessary has been removed, and what’s left is the perfect balance of words and visuals. That’s what we’re building here at Shopify.
4040

4141

4242
## Content 🤝 design

polaris.shopify.com/content/content/inclusive-language.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Inclusive language
3-
description: Make commerce better for everyone by writing inclusively.
3+
description: Make commerce better for everyone by writing inclusively
44
icon: EyeCheckMarkIcon
55
order: 6
66
keywords:

polaris.shopify.com/content/content/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Content
33
order: 4
4-
description: Thoughtful, crafted content is a core element of a well-designed user experience
4+
description: How to use content to build a world-class user experience
55
icon: TextAlignmentLeftIcon
66
---
77

polaris.shopify.com/content/content/naming.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Naming
3-
description: What to consider as you name products and features
3+
description: What to consider as you name products or features
44
icon: ProductIcon
55
order: 4
66
keywords:

polaris.shopify.com/content/getting-started/index.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The [Shopify/polaris GitHub repo](https://github.com/Shopify/polaris) is an open
4141

4242
## Tutorials
4343

44-
### [Build a Shopify app](https://shopify.dev/apps/getting-started/create)
44+
#### [Build a Shopify app](https://shopify.dev/apps/getting-started/create)
4545

4646
In this tutorial, you'll create an app that merchants can access in the Shopify admin. You'll use an app initialization command that generates starter code for building your app, and sets up your development environment so that you can work with your app using [Shopify CLI](https://shopify.dev/apps/tools/cli).
4747

@@ -51,6 +51,6 @@ Your app will use Polaris and [App Bridge](https://shopify.dev/apps/tools/app-br
5151

5252
Polaris provides foundational design guidance for creating good merchant experiences. Here are some recommended resources to:
5353

54-
- [Experience Values](/foundations/experience-values)
54+
- [Experience values](/foundations/experience-values)
5555
- [Design guidelines](/design)
56-
- [Product content](/content/product-content)
56+
- [Content fundamentals](/content/fundamentals)

polaris.shopify.com/content/patterns/common-actions/variants/best-practices.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ keywords:
1818

1919
Actions should always clearly communicate their purpose by using a text label, an icon, or a combination of both.
2020

21-
See the [actionable language guidelines](/content/actionable-language#buttons) for more detail.
21+
See [fundamentals](/content/fundamentals#inspire-action) for more detail.
2222

2323
</Stack>
2424

polaris.shopify.com/next.config.js

+10
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,16 @@ const nextConfig = {
169169
destination: '/content/fundamentals',
170170
permanent: true,
171171
},
172+
{
173+
source: '/content/voice-and-tone',
174+
destination: '/content/fundamentals',
175+
permanent: true,
176+
},
177+
{
178+
source: '/content/merchant-to-customer',
179+
destination: '/content/fundamentals',
180+
permanent: true,
181+
},
172182
...whatsNew,
173183
...actions,
174184
...deprecated,

0 commit comments

Comments
 (0)