Skip to content

[Cache] ELI5: Simplify performance-review docs#30634

Merged
Oxyjun merged 1 commit intoproductionfrom
jun/cache/performance-review/eli5
May 7, 2026
Merged

[Cache] ELI5: Simplify performance-review docs#30634
Oxyjun merged 1 commit intoproductionfrom
jun/cache/performance-review/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/performance-review/
  • Define key terms inline (cache ratio, cache statuses, Edge Cache TTL, revalidation)
  • Fix factual and syntax issues found during analysis

Changes by file

File Key changes
index.mdx Replace generic intro with value-oriented context about cache hit ratios and origin load
cache-analytics.mdx Clarify revalidation counting per view, fix inaccurate "10% sample" claim to match adaptive sampling docs, add inline cache status context, format HTTP status codes per style guide
cache-performance.mdx Define "cache ratio" in opening, add one-sentence inline definitions for all cache statuses, fix double-parenthesis syntax error, replace vague "enable revalidation at your origin" with specific headers and link, rename "Argo Tiered Caching" to "Tiered Cache", replace "negative matching" jargon with plain language

Review notes

All changes validated through adversarial review. No unsourced critical claims. Key fix: the original cache-analytics.mdx claimed data was "based on a 10% sample" but the sampling docs describe adaptive sampling at multiple resolutions (100%/10%/1%), not a fixed 10%.

Apply ELI5 analysis to improve readability across 3 pages:
- index.mdx: Add value-oriented context about cache hit ratios
- cache-analytics.mdx: Clarify revalidation counting, fix 10% sampling claim to match adaptive sampling docs, define cache statuses inline
- cache-performance.mdx: Define cache ratio, fix syntax error, add inline cache status definitions, replace Argo Tiered Caching with Tiered Cache, link revalidation headers
@Oxyjun Oxyjun requested review from a team and dcpena as code owners May 6, 2026 12:41
@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/performance-review/cache-performance.mdx
@Oxyjun Oxyjun merged commit 4663e69 into production May 7, 2026
18 checks passed
@Oxyjun Oxyjun deleted the jun/cache/performance-review/eli5 branch May 7, 2026 13:31
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.

3 participants