Skip to content

Commit 4c310f4

Browse files
[Windsruf] Moving everything to one rule file (#26435)
* changed for always on * moved eveyrhing to one set of rules
1 parent 1c3c048 commit 4c310f4

File tree

2 files changed

+31
-35
lines changed

2 files changed

+31
-35
lines changed

.windsurf/rules/docs-style-guide.md

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

.windsurf/rules/general-rules.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,34 @@ This code would only be rendered if the page has a magicWord variable set to "ha
3131
- Only use the <Markdown /> component in JSX conditionals, and only if needed.
3232
- Do not duplicate content when creating ternary or binary conditions.
3333
- When adding a variable to a link, use HTML instead of Markdown.
34-
- Whenever something is not clear, ask the user for more input.
34+
- Whenever something is not clear, ask the user for more input.
35+
36+
# General styling
37+
38+
- Follow all guidance in the [Cloudflare Style Guide](https://developers.cloudflare.com/style-guide/).
39+
40+
## Grammar rules
41+
42+
- Do not use contractions, exclamation marks, or non-standard quotes like `‘’“”`
43+
- Fix common spelling errors, specifically misspellings of "wrangler"
44+
- Remove whitespace characters from the end of the line.
45+
- Remove duplicate words.
46+
47+
## Links
48+
49+
- 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
50+
- 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/`).
51+
- For links without anchors, always use a trailing slash
52+
- Use meaningful link words, such as the title of the linked page. Avoid link words like "here", "this page", "our documentation", or "read more".
53+
- 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.
54+
55+
## Components
56+
57+
- If a component is used in a page, it needs to be imported below the initial frontmatter (`import { DashButton } from "~/components";`)
58+
- 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/).
59+
- 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/).
60+
- Replace `txt` blocks attempted to show a file tree with our [`FileTree` component](https://developers.cloudflare.com/style-guide/components/file-tree/).
61+
- Replace `sh` blocks using `npm commands` with our [`PackageManagers` component](https://developers.cloudflare.com/style-guide/components/package-managers/).
62+
- 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/).
63+
- 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/).
64+
- 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)