Skip to content

Commit 9343bd4

Browse files
kodster28caley-b
andauthored
Apply suggestions from code review
Co-authored-by: Caley Burton <[email protected]>
1 parent 54f4690 commit 9343bd4

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

src/content/docs/style-guide/documentation-content-strategy/component-attributes/screenshots.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ We only recommend screenshots in [specific scenarios](#when-to-use), as they hav
99

1010
## When to use
1111

12-
Use screenshots sparingly and intentionally, often accompanying a simple, but commonly confused task in the Cloudflare dashboard.
12+
Use screenshots sparingly and intentionally. For example, it's appropriate to use a screenshot when the task is simple but often confuses users or is hard to describe with words alone.
1313

1414
A canonical example of this would be [Find account and zone ID](/fundamentals/account/find-account-and-zone-ids/) because:
1515

src/content/docs/style-guide/how-we-docs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { DirectoryListing } from "~/components";
99

1010
This section shares how Cloudflare approaches docs strategically, covering topics like `how we built our site` and `how we think about redirects`.
1111

12-
The goal is twofold, because it:
12+
The goal is twofold because it:
1313

1414
- Encourages deep thinking about how we approach things (and if they could be better).
1515
- Contributes back to the open-source ecosystem. We get a lot of benefits from being open source and we want to give back.

src/content/docs/style-guide/how-we-docs/links.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Of these three [link types](#link-types), only **Internal** links:
4040
- Universally lead to a bad customer experience (a `404` page).
4141
- Are easily auditable within the current context.
4242

43-
For these reasons, we choose to **fail** a build based on broken internal links. For our implementation, we rely on the [Starlight link validator plugin](https://github.com/HiDeoo/starlight-links-validator).
43+
For these reasons, we choose to make a build **fail** based on broken internal links. For our implementation, we rely on the [Starlight link validator plugin](https://github.com/HiDeoo/starlight-links-validator).
4444

4545
<GitHubCode
4646
repo="cloudflare/cloudflare-docs"
@@ -62,7 +62,7 @@ We also make two intentional decisions about this link auditing:
6262

6363
Though external links are not good for the customer experience, they also don't change within the context of a change to your site's content. Additionally, external link checking can be time consuming and error prone, which can slow down contributions.
6464

65-
We use an external SEO tool to help flag these broken external links for us, addressing them as needed (instead of failing a build on them).
65+
We use an external SEO tool to help flag these broken external links for us, addressing them as needed (instead of making a build fail because of them).
6666

6767
### Anchor links
6868

0 commit comments

Comments
 (0)