Repository navigation
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #275 +/- ##
=======================================
Coverage 94.79% 94.80%
=======================================
Files 84 84
Lines 13199 13199
Branches 805 805
=======================================
+ Hits 12512 12513 +1
+ Misses 621 620 -1
Partials 66 66
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
lan17
force-pushed
the
docs/readme-top-down
branch
2 times, most recently
from
November 12, 2026 06:03
1686988 to
fff12cb
Compare
Owner
Author
|
Agent: review-loop (report mode; lanes: correctness, simplicity, contracts, holistic two-stage) on Fixed (medium)
Open question for the maintainer (low)
Noted, not changed
Local checks at — Levicus Connecto 🤖 |
lan17
force-pushed
the
docs/readme-top-down
branch
from
November 12, 2026 06:17
fff12cb to
594e6b7
Compare
lan17
marked this pull request as ready for review
November 12, 2026 06:30
Lead with what DialCache is and what each registered use case gets: runtime configuration, metrics and invalidation. Follow with one TypeScript example that shows all three, the rollout safety properties, the language table, install, the read path and the documentation map. Re-key the README in the source audit and assign contracts to the new Example, Safe to roll out and Languages sections; re-pin the audit dispositions digest in the Go parity ledger; update the section count quoted in the catalogs lesson of the course.
lan17
force-pushed
the
docs/readme-top-down
branch
from
November 12, 2026 06:32
594e6b7 to
8fe72f5
Compare
This branch has not been deployed
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.
Problem
The README opened with a feature list and a language table, and the one example showed only process-local caching. A reader had to go to
docs/to learn the point of DialCache: caching organized into use cases, each with its own runtime configuration, metrics and invalidation. Discussed with the maintainer; no issue.Change
Rewrite
README.mdtop-down. Docs change type; no design record, no behavior changes.keyTypeand id). Safety defaults in one paragraph.GetUserwith Redis configured but ramped to 0, reads insideenable(), then invalidates after a write. The text after it shows the metric lines the example produces, the runtime override ({ "ramp": { "remote": 10 } }) that starts Redis serving without a deploy, and what the invalidation call fences, including that local layers are not fenced.Published anchors (
changing-policy-at-runtime,enabled-scope,cache-layers,reference) stay in place. The source audit re-keys the README; the newExample,Safe to roll outandLanguagessections get contract dispositions (C01/C05/C16/C18/C32/W01, C01/C13/C17/C27/C40/C47 and B01), and the Go parity ledger re-pins the dispositions digest. The README now has eight sections instead of seven, so the section count quoted informal/guides/course/13-catalogs-and-ledgers.mdmoves from 216 to 217 (thequintCI lane checks that quote).Choices a reviewer may want to reverse: the example keeps a 60 s local TTL next to the
invalidateRemotecall, and the note says local hits are not fenced; the pitch keeps its second paragraph (off by default on the first screen) although the simplicity review lane suggested deleting it; the formerUsageandRuntime controlsections are folded into the example and its notes.Validation
Head:
a79cdc5fe065b2ac84a83619d5ce7358fc0dc8bbnode formal/tools/validation.mjs audit(the fullmake auditlane: source audit, semantic coverage, feature coverage, Go parity, fixture fingerprints, Quint style caps, course citations, generated views) ata79cdc5: passednode formal/tools/check-source-audit.mjsata79cdc5: passednode formal/tools/check-go-parity.mjsata79cdc5: passedcorepack pnpm run docs:checkata79cdc5: passed (ports: 4, imports: 12, formalLinks: { pages: 56 })corepack pnpm vitest run test/formal-source-audit.test.ts(typescript/) ata79cdc5: 23 passedreview-loop, report mode (correctness, simplicity, contracts, holistic) at
2042a62: 3 medium findings fixed infff12cb(invalidation note no longer promises a source read on the next call and names thefutureBufferMsargument; fail-open bullet distinguishes provider errors from invalid fields); 1 low finding (delete the pitch's second paragraph) not applied; see Change.Not run: none required for a Docs change beyond PR CI.
Follow-ups
None filed. Worth a separate look: the
README.mdrow of the source index informal/guides/CONTRACTS.mdlists neither the contracts assigned here (C13, C27, C32, C40, C47) nor C31, which the previous README already carried.