[Rules] Document pre-deployment validation - #33523
Open
mbullock1986 wants to merge 2 commits into
Open
mbullock1986 wants to merge 2 commits into
mbullock1986 wants to merge 2 commits into
Conversation
Contributor
Review💡 3 suggestions found in commit 👉 Fix in your agent 👈Fix the following review findings in PR #33523 (https://github.com/cloudflare/cloudflare-docs/pull/33523).
Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order
After triaging, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.
The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.
---
## Style Guide Review
### Suggestions (3)
#### SG-cf92f167a65f · Use <APIRequest> instead of <CURL> for Cloudflare API endpoints
- **File:** `src/content/docs/ruleset-engine/rulesets-api/dry-run.mdx` line 48
- **Issue:** Added <CURL> props document a Cloudflare API endpoint (https://api.cloudflare.com/client/v4/zones/...) with headers, query, and json
- **Fix:** Use the <APIRequest> component instead of <CURL> when documenting a Cloudflare API endpoint
#### SG-f9f191f02421 · Semicolons joining independent clauses
- **File:** `src/content/changelog/rules/2026-09-17-rulesets-dry-run-validation.mdx` line 11
- **Issue:** Line 11 uses a semicolon to join two independent clauses: `... return \`result: null\`; operations that normally return \`204\` continue to do so.`
- **Fix:** Break into two sentences, e.g. `Successful operations that normally return a \`200\` response return \`result: null\`. Operations that normally return \`204\` continue to do so.`
#### SG-359e6a8a55dc · Avoid semicolons joining independent clauses
- **File:** `src/content/changelog/rules/2026-09-17-rulesets-dry-run-validation.mdx` line 11
- **Issue:** `...return `result: null`; operations that normally return `204` continue to do so.` joins two independent clauses with a semicolon.
- **Fix:** Break into two sentences: `...return `result: null`. Operations that normally return `204` continue to do so.`
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. No code review issues found. ConventionsNo convention issues found. Style Guide ReviewSuggestions (3)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
Contributor
Review coverage🟡 2 ownership areas need approval.
CODEOWNERS mappings for displayed areas (2)
|
DavidJKTofan
added a commit
to DavidJKTofan/davidtofan
that referenced
this pull request
Sep 18, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
dry_run=truequery parameter.Related: SHIP-11749
Documentation checklist