Skip to content

Commit 055ef5e

Browse files
[Style guide] Update banner guidance and Get started template (#17504)
* Remove word Step from headings in Get started template * Create page with guidance around banners in docs * Remove banner example from index.mdx and text-refine new page
1 parent c2067ef commit 055ef5e

File tree

3 files changed

+34
-19
lines changed

3 files changed

+34
-19
lines changed

src/content/docs/style-guide/documentation-content-strategy/content-types/get-started.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,23 +43,23 @@ The purpose of Get started content is to help users go from not using a product
4343
weight: xx
4444
pcx_content_type: get-started
4545
---
46-
46+
4747
# Get started
48-
48+
4949
Description
50-
50+
5151
## Before you begin
52-
52+
5353
All the things you need to do before you start configuring your product, both within Cloudflare and outside.
54-
55-
## Step 1 -- Step description
56-
57-
## Step 2 -- Steps until you get to activation
58-
54+
55+
## 1. Step description
56+
57+
## 2. Steps until you get to activation
58+
5959
---
60-
60+
6161
## Next steps
62-
62+
6363
Point to more complex setup options.
6464
```
6565

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Banner
3+
description: How to display a banner at the top of the page and when to use it.
4+
banner:
5+
content: Do <strong>not</strong> use banners in the <a href="/style-guide/frontmatter/">Frontmatter</a> unless a change will cause customer application to break.
6+
---
7+
8+
import { Steps, FileTree } from "~/components";
9+
10+
One of the fields you can add to the [Frontmatter](/style-guide/frontmatter/) is `banner`. It displays a prominent section at the top of the page and supports the use of HTML for links and formatting.
11+
12+
Only use it to alert about disruptive situations and take note to remove it when applicable.
13+
14+
## Example
15+
16+
```mdx wrap
17+
---
18+
title: Banner
19+
description: How to display a banner at the top of the page and when to use it.
20+
banner:
21+
content: Do <strong>not</strong> use banners in the <a href="/style-guide/frontmatter/">Frontmatter</a> unless a change will cause customer application to break.
22+
---
23+
```

src/content/docs/style-guide/frontmatter/index.mdx

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ description: |
55
For example, a regular page might set title and description fields.
66
sidebar:
77
order: 3
8-
banner:
9-
content: |
10-
<h2>Hello, world!</h2>
11-
<a href="/">Homepage</a>
128
---
139

1410
Frontmatter contains the metadata for a page, such as the `title`. It is written as YAML, between `---`, at the top of the page.
@@ -23,10 +19,6 @@ description: |
2319
For example, a regular page might set title and description fields.
2420
sidebar:
2521
order: 3
26-
banner:
27-
content: |
28-
<h2>Hello, world!</h2>
29-
<a href="/">Homepage</a>
3022
---
3123
```
3224

0 commit comments

Comments
 (0)