docs: focus README on safe cache rollouts - #89
Draft
lan17 wants to merge 7 commits into
Draft
Conversation
48 tasks
lan17
force-pushed
the
docs/readme-safety-adoption
branch
2 times, most recently
from
July 26, 2026 00:27
3d14c88 to
09d3ee5
Compare
lan17
force-pushed
the
docs/readme-safety-adoption
branch
from
July 26, 2026 03:04
09d3ee5 to
4a2dc71
Compare
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
mainwith a 2,535-word adoption guide that identifies DialCache as a TypeScript read-through caching library before explaining its production and high-scale patternscached()or usegetOrLoad()inline; after active layers miss, DialCache calls the application loader and publishes to active request-local, bounded process-local, and optional Redis or Valkey layersdocs/is not included in the package tarball>=22.0.0minimum and supported-LTS recommendation from currentv0.13.0Why
The README on current
mainis technically thorough but makes experienced backend engineers work too hard to establish the basic mental model: What kind of cache is this? What happens on a miss? Which layers does it manage? Which production patterns does it add, and which infrastructure and safety decisions remain application-owned?The revised README answers those questions before setup. It frames DialCache as read-through caching first, then introduces request coalescing, runtime policy, deterministic ramp-up and ramp-down, fail-open reads, non-serving Redis shadow validation and bootstrap, targeted invalidation, deadlines, serialization, and backend-neutral observability.
v0.13.0 refresh
This branch now includes current
mainand documents the contracts added inv0.12.0andv0.13.0:shadowRamp,shadowMaxInFlight,shadowComparator, independent serving/shadow cohorts, and complete kill-switch semanticsC0/ source /C1confirmation modelremote_shadow, all bounded outcomes, and observer rejection isolationImpact
This is documentation-only relative to current
mainatv0.13.0.Merging this PR does not republish
v0.13.0; the rewritten README will appear on npm with a future package release. Its absolute links will resolve to the merged reference guides onmain.Validation
corepack pnpm checkunder Node 22.22.0 — strict typecheck, 384 unit tests with coverage, builds/declarations, and packed consumerscorepack pnpm test:integration— 93 Redis, Valkey, and Redis Cluster testscorepack pnpm benchmark:request-local— all ten semantic scenarios passedgit diff --check