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

---

trigger: glob globs: *.mdx

General styling

• Follow all guidance in the Cloudflare Style Guide.

Grammar rules

• Do not use contractions, exclamation marks, or non-standard quotes like ‘’“”
• Fix common spelling errors, specifically misspellings of "wrangler"
• Remove whitespace characters from the end of the line.
• Remove duplicate words.

Links

• 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
• 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/).
• For links without anchors, always use a trailing slash
• Use meaningful link words, such as the title of the linked page. Avoid link words like "here", "this page", "our documentation", or "read more".
• 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.

Components

• If a component is used in a page, it needs to be imported below the initial frontmatter (import { DashButton } from "~/components";)
• If https://dash.cloudflare.com is used in a series of steps, replace with the DashButton component.
• Replace sh code blocks that have requests to https://api.cloudflare.com with our APIRequest component.
• Replace txt blocks attempted to show a file tree with our FileTree component.
• Replace sh blocks using npm commands with our PackageManagers component.
• Replace in-text mentions of Cloudflare's number of data centers, network capacity, or network peers with our PublicStats component.
• Replace toml or json code blocks with Wrangler configuration information with our WranglerConfig component.
• Replace ts or typescript code blocks with our TypeScriptExample component. Ignore this rule if the original code block is within a tutorial or other step-by-step guide that is specific to TypeScript.