Skip to content

Commit 378b536

Browse files
committed
[windsurf] Initial style guide
1 parent dcebdd8 commit 378b536

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
trigger: glob
3+
globs: *.mdx
4+
---
5+
6+
# General styling
7+
8+
- Follow all guidance in the [Cloudflare Style Guide](https://developers.cloudflare.com/style-guide/).
9+
10+
## Grammar rules
11+
12+
- Do not use contractions, exclamation marks, or non-standard quotes like `‘’“”`
13+
- Fix common spelling errors, specifically misspellings of "wrangler"
14+
- Remove whitespace characters from the end of the line.
15+
- Remove duplicate words.
16+
17+
## Links
18+
19+
- Use links that exist in the current file context. In most cases, these links will be very close to those at https://developers.cloudflare.com/sitemap-0.xml
20+
- When referring to another page in our docs, use the full relative link (`/1.1.1.1/check/`) instead of the full URL (`https://developers.cloudflare.com/1.1.1.1/check/`), a local development link (`http://localhost:1111/1.1.1.1/check/`), or a dot notation link `../check/`).
21+
- For links without anchors, always use a trailing slash
22+
- Use meaningful link words, such as the title of the linked page. Avoid link words like "here", "this page", "our documentation", or "read more".
23+
- Where appropriate, add cross links to relevant other pages in our documentation. These links will exist in the current file context and most are also available at https://developers.cloudflare.com/sitemap-0.xml.
24+
25+
## Components
26+
27+
- If a component is used in a page, it needs to be imported below the initial frontmatter (`import { DashButton } from "~/components";`)
28+
- If `https://dash.cloudflare.com` is used in a series of steps, replace with the [`DashButton` component](https://developers.cloudflare.com/style-guide/components/dash-button/).
29+
- Replace `sh` code blocks that have requests to `https://api.cloudflare.com` with our [`APIRequest` component](https://developers.cloudflare.com/style-guide/components/api-request/).
30+
- Replace `txt` blocks attempted to show a file tree with our [`FileTree` component](https://developers.cloudflare.com/style-guide/components/file-tree/).
31+
- Replace `sh` blocks using `npm commands` with our [`PackageManagers` component](https://developers.cloudflare.com/style-guide/components/package-managers/).
32+
- Replace in-text mentions of Cloudflare's number of data centers, network capacity, or network peers with our [`PublicStats` component](https://developers.cloudflare.com/style-guide/components/public-stats/).
33+
- Replace `toml` or `json` code blocks with [Wrangler configuration](https://developers.cloudflare.com/workers/wrangler/configuration/#sample-wrangler-configuration) information with our [`WranglerConfig` component](https://developers.cloudflare.com/style-guide/components/wrangler-config/).
34+
- Replace `ts` or `typescript` code blocks with our [`TypeScriptExample` component](https://developers.cloudflare.com/style-guide/components/typescript-example/). Ignore this rule if the original code block is within a tutorial or other step-by-step guide that is specific to TypeScript.

0 commit comments

Comments
 (0)