Skip to content

docs: fix grammar mistakes across product docs#31155

Open
Maximo-Guk wants to merge 1 commit into
productionfrom
grammar-fixes-prose
Open

docs: fix grammar mistakes across product docs#31155
Maximo-Guk wants to merge 1 commit into
productionfrom
grammar-fixes-prose

Conversation

@Maximo-Guk
Copy link
Copy Markdown
Member

This PR fixes various grammar mistakes found across the documentation:

  • Subject-verb agreement corrections
  • Tense consistency fixes
  • Article usage corrections
  • Other minor grammar improvements

Files updated: 12 files across API Shield, Cache, DNS, Queues, R2, Realtime, Reference Architecture, Speed, Troubleshooting, and WAF documentation.

Fixes a mix of article (a/an) errors, subject-verb agreement,
duplicate words, and missing object pronouns in prose across
12 docs pages spanning API Shield, Cache, DNS, Queues, R2,
Realtime, Reference Architecture, Speed, Support, and WAF.

No technical meaning, code, links, or component usage changed.
@cloudflare-docs-bot
Copy link
Copy Markdown

cloudflare-docs-bot Bot commented May 30, 2026

Review

⚠️ 1 warning and 1 suggestion found in commit 67752a2.

Warnings (1)
File Issue
cache/how-to/tiered-cache.mdx line 46 No 'please' in prose — Line contains 'please engage your account team' Fix: Remove 'please' — rewrite as 'If you want a custom topology, engage your account team.'
Suggestions (1)
File Issue
reference-architecture/architectures/sase.mdx line 178 e.g. usage — Line adds (e.g. determining whether...) Fix: Replace e.g. with for example or restructure.
Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.

@github-actions github-actions Bot added product:dns Issues or PRs related to DNS product:cache Issues or PRs related to Cache product:waf product:r2 R2 object storage: https://developers.cloudflare.com/r2 product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:reference-architecture product:api-shield product:support product:speed product:realtime size/s labels May 30, 2026
@github-actions
Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/api-shield/ @patriciasantaana, @cloudflare/appsec-reviewers, @elithrar, @xmflsct, @cloudflare/product-owners
/src/content/docs/cache/ @cloudflare/product-owners
/src/content/docs/dns/ @RebeccaTamachiro, @hannes-cf, @cloudflare/product-owners, @esomoza-cf, @fattouche, @xofyarg, @dklbreitling, @chreo, @svenr-cf, @kerolasa, @matildeopbravo, @vavrusa, @mworsley-cloudflare, @sebastiaanyn, @vendemiat, @Woutifier
/src/content/docs/queues/ @elithrar, @jonesphillip, @harshil1712, @mia303, @cloudflare/product-owners
/src/content/docs/r2/ @oxyjun, @elithrar, @jonesphillip, @aninibread, @harshil1712, @cloudflare/workers-docs, @cloudflare/product-owners
/src/content/docs/realtime/ @cloudflare/product-owners, @cloudflare/realtime, @cloudflare/RealtimeKit, @roerohan, @ravindra-cloudflare
/src/content/docs/reference-architecture/ @securitypedant, @cloudflare/product-owners, @ncrouch-cflare
/src/content/docs/speed/ @cloudflare/product-owners
/src/content/docs/support/ @cloudflare/product-owners, @cloudflare/customer-support, @ngayerie, @krys-cf, @stechedo, @zeinjaber, @shanecloudflare
/src/content/docs/waf/ @pedrosousa, @cloudflare/firewall, @cloudflare/appsec-reviewers, @elithrar, @cloudflare/product-owners

Copy link
Copy Markdown
Contributor

@ask-bonk ask-bonk Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 12 grammar fixes across product docs. Most changes are correct and improve prose quality. One change may need reconsideration, and one pre-existing issue is worth noting.

@ask-bonk ask-bonk Bot added documentation Documentation edits content:edit Request for content edits labels May 30, 2026
Copy link
Copy Markdown
Contributor

@ask-bonk ask-bonk Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All 12 grammar fixes are correct and improve prose quality. No issues found.

Out-of-scope note: has a pre-existing numbering issue where step is repeated (lines 60–61). This is unrelated to the grammar fix.

Copy link
Copy Markdown
Contributor

@ask-bonk ask-bonk Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All 12 grammar fixes are correct and improve prose quality. No issues found.

Out-of-scope note: src/content/docs/dns/zone-setups/conversions/convert-full-to-secondary.mdx has a pre-existing numbering issue where step 3 is repeated (lines 60–61). This is unrelated to the grammar fix.

@ask-bonk
Copy link
Copy Markdown
Contributor

ask-bonk Bot commented May 30, 2026

I reviewed PR #31155 and applied the labels documentation and content:edit.

Verdict: All 12 grammar fixes are correct. No issues that need correcting before merge.

Summary of changes
The PR makes minor, accurate grammar corrections across 12 files:

  • Fixes subject–verb agreement (there is a fewthere are a few)
  • Fixes article usage (an uniquea unique, a existingan existing, an stringa string, on an useron a user, is a exampleis an example, configure an customconfigure a custom)
  • Removes doubled words (Back to the theBack on the, via the thevia the)
  • Fixes bare infinitives after allow (allows toallows you to)
  • Adds missing article (for specific Ray IDfor a specific Ray ID)

Out-of-scope note
src/content/docs/dns/zone-setups/conversions/convert-full-to-secondary.mdx has a pre-existing numbering issue where step 3 is repeated (lines 60–61). This is unrelated to the grammar fix and could be cleaned up in a separate PR.

github run

@github-actions
Copy link
Copy Markdown
Contributor

Preview URL: https://67752a27.preview.developers.cloudflare.com
Preview Branch URL: https://grammar-fixes-prose.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/api-shield/security/jwt-validation/api/ https://grammar-fixes-prose.preview.developers.cloudflare.com/api-shield/security/jwt-validation/api/
https://developers.cloudflare.com/cache/how-to/tiered-cache/ https://grammar-fixes-prose.preview.developers.cloudflare.com/cache/how-to/tiered-cache/
https://developers.cloudflare.com/dns/zone-setups/conversions/convert-full-to-secondary/ https://grammar-fixes-prose.preview.developers.cloudflare.com/dns/zone-setups/conversions/convert-full-to-secondary/
https://developers.cloudflare.com/queues/configuration/pull-consumers/ https://grammar-fixes-prose.preview.developers.cloudflare.com/queues/configuration/pull-consumers/
https://developers.cloudflare.com/r2/api/workers/workers-api-reference/ https://grammar-fixes-prose.preview.developers.cloudflare.com/r2/api/workers/workers-api-reference/
https://developers.cloudflare.com/realtime/turn/replacing-existing/ https://grammar-fixes-prose.preview.developers.cloudflare.com/realtime/turn/replacing-existing/
https://developers.cloudflare.com/realtime/turn/what-is-turn/ https://grammar-fixes-prose.preview.developers.cloudflare.com/realtime/turn/what-is-turn/
https://developers.cloudflare.com/reference-architecture/architectures/sase/ https://grammar-fixes-prose.preview.developers.cloudflare.com/reference-architecture/architectures/sase/
https://developers.cloudflare.com/speed/optimization/content/speed-brain/ https://grammar-fixes-prose.preview.developers.cloudflare.com/speed/optimization/content/speed-brain/
https://developers.cloudflare.com/support/troubleshooting/http-status-codes/4xx-client-error/ https://grammar-fixes-prose.preview.developers.cloudflare.com/support/troubleshooting/http-status-codes/4xx-client-error/
https://developers.cloudflare.com/support/troubleshooting/http-status-codes/cloudflare-5xx-errors/ https://grammar-fixes-prose.preview.developers.cloudflare.com/support/troubleshooting/http-status-codes/cloudflare-5xx-errors/
https://developers.cloudflare.com/waf/reference/legacy/old-rate-limiting/ https://grammar-fixes-prose.preview.developers.cloudflare.com/waf/reference/legacy/old-rate-limiting/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content:edit Request for content edits documentation Documentation edits product:api-shield product:cache Issues or PRs related to Cache product:dns Issues or PRs related to DNS product:queues Cloudflare Queues: https://developers.cloudflare.com/queues product:r2 R2 object storage: https://developers.cloudflare.com/r2 product:realtime product:reference-architecture product:speed product:support product:waf size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.