[Cache] Add missing purge edge-case documentation - #33305
Open
ngayerie wants to merge 3 commits into
Open
Conversation
ngayerie
requested review from
a team,
ack-cf,
mbullock1986 and
zaidoon1
as code owners
September 8, 2026 15:00
Contributor
Review
👉 Fix in your agent 👈Fix the following review findings in PR #33305 (https://github.com/cloudflare/cloudflare-docs/pull/33305).
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.
---
## Code Review
### Warnings (1)
#### CR-ebc8cb85e6c5 · Literal backslash in title frontmatter
- **File:** `src/content/docs/cache/how-to/purge-cache/purge-everything.mdx` line 2
- **Issue:** The title `\Purge everything` contains a literal backslash. In an unquoted YAML plain scalar, `\` is not an escape character, so the page title will render as "\Purge everything" in the browser tab, sidebar, and SEO title. The base version of this line had no backslash.
- **Fix:** Remove the stray backslash so the title is `Purge everything`.
---
## Style Guide Review
### Warnings (1)
#### SG-4173c8951d64 · Admonitions — valid syntax is `:::caution`
- **File:** `src/content/docs/cache/how-to/purge-cache/purge-everything.mdx` line 18
- **Issue:** Added line opens the admonition with `::caution` (two colons) while the closing delimiter is `:::` (three colons); the admonition will not render.
- **Fix:** Change `::caution` to `:::caution`.
### Suggestions (4)
#### SG-bc1553c59f4b · Monospace formatting for HTTP status codes
- **File:** `src/content/docs/cache/how-to/purge-cache/purge-by-single-file.mdx` line 57
- **Issue:** Line 57 writes HTTP status codes as plain prose: "returns a redirect (301 or 302)"
- **Fix:** Wrap status codes in backticks: "returns a redirect (`301` or `302`)"
#### SG-fb30331a9903 · Passive voice
- **File:** `src/content/docs/cache/how-to/purge-cache/purge-everything.mdx` line 19
- **Issue:** Added line uses passive constructions: "all cached content for your zone is removed at once" and "Every subsequent request must be served from your origin until the cache is repopulated."
- **Fix:** Rewrite in active voice, e.g. "Purging removes all cached content for your zone at once. Your origin serves every subsequent request until the cache is repopulated."
#### SG-51765696c57c · Passive voice
- **File:** `src/content/docs/cache/how-to/purge-cache/index.mdx` line 20
- **Issue:** `This indicates the request was received ... that the targeted content was cached or that any content was evicted` uses passive constructions
- **Fix:** Rewrite in active voice, e.g. `This indicates the API received the request — it does not confirm the cache held the content or evicted anything.`
#### SG-5f43e390802b · Monospace for HTTP status codes
- **File:** `src/content/docs/cache/how-to/purge-cache/index.mdx` line 20
- **Issue:** `returns HTTP 200` — HTTP status codes should be in backticks (`HTTP 200`)
- **Fix:** Use `` `HTTP 200` `` instead of `HTTP 200`
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. Warnings (1)
ConventionsNo convention issues found. Style Guide ReviewWarnings (1)
Suggestions (4)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://cache-purge-edge-case-docs.previews.developers.cloudflare.com (commit a648e1a)This URL reflects your latest Preview deploymentPreview Deployments by commit
|
Contributor
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
4 participants
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.
Three small additions to the cache purge documentation covering edge cases that frequently cause customer confusion in support.
index.mdx— Add a note clarifying that a successful purge request returns HTTP 200, but 200 does not confirm that the targeted content was cached or that any content was evicted. Customers often interpret a 200 response as confirmation that the purge worked, then report that Cloudflare is broken when content does not update. The note recommends verifying by checking thatCF-Cache-Statusis no longerHIT.purge-by-single-file.mdx— Add a "Redirect responses" subsection explaining that purging a URL which returns a 301 or 302 removes the cached redirect response, not the content at the redirect destination. The destination resource remains cached. Customers need to purge the final destination URL directly.purge-everything.mdx— Promote the existing inline performance warning to a dedicated:::cautioncallout and add a recommendation to consider targeted purge methods (by URL, prefix, or tag) first to avoid overloading the origin with a cache-fill spike.