Skip to content

Commit 748d973

Browse files
kodster28caley-b
andauthored
Style guide best practices (#23516)
* structure * Image maintenance * Add page on screenshots * Finish screenshot guidelines * migrated over info on redirects * structure for metadata page * Add in code examples for metadata * Added scripts and links to redirects * Finish adding in links * Denise feedback * Apply suggestions from code review Co-authored-by: Caley Burton <[email protected]> * Tweaks from Caley * Small update --------- Co-authored-by: Caley Burton <[email protected]>
1 parent fe7ad02 commit 748d973

File tree

20 files changed

+549
-221
lines changed

20 files changed

+549
-221
lines changed

public/__redirects

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1312,6 +1312,14 @@
13121312
/stream/platform/ /stream/changelog/ 301
13131313
/stream/reference/ /stream/faq/ 301
13141314

1315+
# style guide
1316+
1317+
/docs-guide/manage-content/redirects/ /style-guide/how-we-docs/redirects/ 301
1318+
/docs-guide/manage-content/redirects/best-practices/ /style-guide/how-we-docs/redirects/ 301
1319+
/docs-guide/manage-content/redirects/process/ /style-guide/how-we-docs/redirects/ 301
1320+
/docs-guide/manage-content/metadata/ /style-guide/how-we-docs/metadata/ 301
1321+
/docs-guide/manage-content/metadata/process/ /style-guide/how-we-docs/metadata/ 301
1322+
13151323
# support
13161324

13171325
/support/about-cloudflare/getting-started/troubleshooting-faq-for-new-cloudflare-customers/ /fundamentals/reference/troubleshooting/ 301
32.6 KB
Loading
66.6 KB
Loading

src/content/docs/docs-guide/manage-content/metadata/index.mdx

Lines changed: 0 additions & 25 deletions
This file was deleted.

src/content/docs/docs-guide/manage-content/metadata/process.mdx

Lines changed: 0 additions & 52 deletions
This file was deleted.

src/content/docs/docs-guide/manage-content/redirects/best-practices.mdx

Lines changed: 0 additions & 31 deletions
This file was deleted.

src/content/docs/docs-guide/manage-content/redirects/index.mdx

Lines changed: 0 additions & 17 deletions
This file was deleted.

src/content/docs/docs-guide/manage-content/redirects/process.mdx

Lines changed: 0 additions & 54 deletions
This file was deleted.

src/content/docs/style-guide/api-content-strategy/index.mdx

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,17 @@
11
---
22
pcx_content_type: concept
3-
title: API content strategy
3+
title: API docs content strategy
44
sidebar:
55
order: 5
6-
76
---
87

9-
import { DirectoryListing } from "~/components"
8+
import { DirectoryListing } from "~/components";
109

11-
The API content strategy aims to:
10+
The API docs content strategy aims to:
1211

13-
* Reduce internal and external user frustration
14-
* Align with industry standards in terms of naming conventions and descriptions
15-
* Create world-class content that is just as good, or better, than very popular API documentation
12+
- Reduce internal and external user frustration
13+
- Align with industry standards in terms of naming conventions and descriptions
14+
- Create world-class content that is just as good, or better, than very popular API documentation
1615

1716
By ensuring Cloudflare's API content is straightforward, easy to navigate, and consistent, we can create world-class API content that eliminates user frustration and serves as an example of good API documentation.
1817

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

Lines changed: 12 additions & 1 deletion
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
@@ -40,4 +46,9 @@ E[Anycast IP] --> F[/Tunnel 1 / <br/> priority 1/] --> I{{Customer <br/> data ce
4046
E[Anycast IP] --> G[/Tunnel 2 / <br/> priority 1/] --> J{{Customer <br/> data center/ <br/> network 2}}
4147
E[Anycast IP] --> H[/Tunnel 3 / <br/> priority 2/] --> K{{Customer <br/> data center/ <br/> network 3}}
4248
```
43-
````
49+
````
50+
51+
## Related components
52+
53+
- [Diagrams](/style-guide/documentation-content-strategy/component-attributes/diagrams/)
54+
- [Screenshots](/style-guide/documentation-content-strategy/component-attributes/screenshots/)

0 commit comments

Comments
 (0)