Skip to content

[Cache] ELI5: Simplify reference docs#30637

Open
Oxyjun wants to merge 3 commits intoproductionfrom
jun/cache/reference/eli5
Open

[Cache] ELI5: Simplify reference docs#30637
Oxyjun wants to merge 3 commits intoproductionfrom
jun/cache/reference/eli5

Conversation

@Oxyjun
Copy link
Copy Markdown
Contributor

@Oxyjun Oxyjun commented May 6, 2026

Summary

  • Apply ELI5 (technical simplification) analysis to 3 pages in docs/cache/reference/
  • Fix style guide violations and improve clarity through inline definitions
  • No changes to index.mdx (navigation page, already clear) or cdn-reference-architecture.mdx (external redirect, no prose)

Changes by file

File Key changes
csam-scanning.mdx Fix "Log into" to "Log in to", replace "we" with "Cloudflare", convert question headings to imperative, remove non-standard horizontal rules, consolidate dashboard login steps per convention
development-mode.mdx Define Polish as "(image optimization)" inline, change "allows customers" to second person, add dashboard login convention, explain why Dev Mode is useful
etag-headers.mdx Expand "ETag" to "ETag (Entity Tag)" on first use, explain why compression causes strong-to-weak conversion, clarify "semantically equivalent" with an example, add cross-links for Rocket Loader/Email Obfuscation/HTTPS Rewrites, link "cache miss" to reference page

Review notes

All changes validated through adversarial review. No unsourced claims. Changes are primarily style guide compliance fixes and inline jargon definitions.

Apply ELI5 analysis to improve readability across 3 pages:
- csam-scanning.mdx: Fix style issues (Log into -> Log in to, we -> Cloudflare, question headings -> imperative), remove horizontal rules, consolidate dashboard login steps
- development-mode.mdx: Define Polish inline, use second person, add dashboard login convention, explain why Dev Mode is useful
- etag-headers.mdx: Define ETag (Entity Tag) on first use, explain why strong-to-weak conversion happens, clarify semantically equivalent, add cross-links for Rocket Loader/Email Obfuscation/HTTPS Rewrites and cache miss
@Oxyjun Oxyjun requested review from a team and dcpena as code owners May 6, 2026 13:11
@github-actions github-actions Bot added product:cache Issues or PRs related to Cache size/s labels May 6, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2026

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

Pattern Owners
/src/content/docs/cache/ @angelampcosta, @dcpena, @cloudflare/pcx-technical-writing, @cloudflare/product-owners

@Oxyjun Oxyjun self-assigned this May 6, 2026
Comment thread src/content/docs/cache/reference/development-mode.mdx Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:cache Issues or PRs related to Cache size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants