Conversation
rust/README.md is what crates.io renders for the dialcache crate, and it never said how to install the crate. This rewrite gives it the shape of the TypeScript README and makes every fact scannable. - Open with the use-case definition, the experimental notice, nine capability bullets and one link line that includes docs.rs. - Add an Install section: cargo add, a feature table, and the MSRV rule (1.85; 1.88 for the redis feature because of the locked redis 1.x). - Show both entry points in the Usage snippet (use_case().register() and get_or_load) plus get_uncached; the snippet compiles, passes rustfmt and runs. Follow it with five gotcha bullets. - Replace fact-list paragraphs with tables for Policy leaves and instance defaults, and keep every paragraph under 60 words and one idea. - Remove protocol-internal terms (request memo, flight, settlement, quiescence) and second person; name the real builder knob shadow_max_in_flight instead of "shadow capacity". - Move contributor-only details (settlement control, driver causality) out; they live in formal/PORTING.md and formal/WALKTHROUGH.md. All 17 links and 3 heading anchors verified. No prose line exceeds 80 columns. Prose length is unchanged (about 2,070 words); readability comes from structure, not deletion.
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.
rust/README.mdis what crates.io renders for thedialcachecrate, and until now it never said how to install it. This rewrite gives the Rust README the shape of the TypeScript README and makes every fact scannable for an engineer evaluating the crate.cargo add, a feature table, and the MSRV rule (1.85; 1.88 for theredisfeature because of the lockedredis1.x dependency).use_case().register()andget_or_load) plusget_uncached, followed by five gotcha bullets.Policyleaves and instance defaults; every paragraph is one idea and under 60 words.shadow_max_in_flightinstead of "shadow capacity".DIALCACHE_RUST_SUITE) out; they live informal/PORTING.mdandformal/WALKTHROUGH.md.Validation: the Usage snippet was extracted into a temporary example and passed
cargo check,rustfmt --checkandcargo run(asserts hold; it printsHello, User 42 <ada@example.com>!). All 17 links and 3 heading anchors resolve. Every factual claim was re-checked againstrust/src(defaults inlimits.rs, builder methods,Errorvariants,Policy::validate, feature gates) and the lockedrediscrate'srust-version.Scope: README prose only. No code, Quint model, conformance assertion or docs-site page changed.
rust/README.mdis not part of the source audit, so no ledger refresh is needed. Prose length is unchanged at about 2,070 words; readability comes from structure, not deletion.