Skip to content

Commit e70f243

Browse files
committed
Finish screenshot guidelines
1 parent 6a9eaeb commit e70f243

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

src/content/docs/style-guide/components/mermaid.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ title: Mermaid
44

55
Mermaid diagrams are added with [`remark-mermaid`](https://github.com/remcohaszing/rehype-mermaid/) and [`mermaid`](https://www.npmjs.com/package/mermaid).
66

7+
## Guidelines
8+
9+
Use Mermaid diagrams to illustrate product or process flows. If they work for your use case, Mermaid diagrams are preferable to other [diagrams](/style-guide/documentation-content-strategy/component-attributes/diagrams/) because they are more easily searchable and changeable.
10+
11+
## Usage
12+
713
```mermaid
814
flowchart LR
915
accTitle: Tunnels diagram

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

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,12 @@ A canonical example of this would be [Find account and zone ID](/fundamentals/ac
1717
- We tried explaining with words alone and that did not solve the confusion.
1818
- It's a task specifically related to new users, where they are less familiar with Cloudflare concepts or navigation patterns.
1919

20+
:::note
21+
22+
Use screenshots liberally in [Changelog entries](/style-guide/documentation-content-strategy/content-types/changelog/), because this content type is an accepted "point-in-time" reference and it's okay for these screenshots to be outdated.
23+
24+
:::
25+
2026
## Guidelines
2127

2228
Screenshots should:
@@ -28,12 +34,14 @@ Screenshots should:
2834
- Avoid including visuals that change frequently, such as sidebar navigation.
2935
- Have descriptive alt text.
3036

31-
## Template
37+
## Usage
3238

3339
```mdx
3440
![Alt text](~/assets/images/$PRODUCT_NAME/$IMAGE_NAME.png)
3541
```
3642

43+
Add screenshots to the corresponsding `$PRODUCT_NAME` folder under [`/src/assets/images/`](https://github.com/cloudflare/cloudflare-docs/tree/production/src/assets/images). You may want to add subfolders for organizational purposes.
44+
3745
## Maintenance
3846

3947
We avoid screenshots without a clear purpose because they are difficult to maintain. This is because:

0 commit comments

Comments
 (0)