Docs/update#135
Merged
Merged
Conversation
…etrics, error model, and weighted eviction - Added detailed documentation on concurrency strategies, outlining the design rationale for concurrent cache types and their usage. - Introduced a metrics section to explain the metrics infrastructure, including recording, snapshotting, and exporting metrics for observability. - Documented the error model, clarifying the panic vs. `Result` discipline and the handling of different error types. - Included a comprehensive overview of weighted eviction strategies, detailing the implementation of `WeightStore` and `ConcurrentWeightStore`. These additions enhance the overall documentation, providing clearer guidance on design principles and usage patterns for developers.
…hashing, sharding, serialization, and non-goals - Added a comprehensive section on benchmarking design, detailing the benchmark layers, goals, and artifact schema to enhance performance evaluation. - Introduced documentation on hashing and key identity, explaining hasher choices, key interning, and shard routing strategies. - Documented sharding design, outlining current sharded primitives, routing requirements, and capacity semantics for improved concurrency. - Included a section on serialization, clarifying the current serialization surface and future considerations for cache-state persistence. - Added a non-goals document to define explicit boundaries for cachekit's design, ensuring clarity on what the library does not aim to achieve. These additions significantly enhance the documentation, providing clearer guidance on design principles and usage patterns for developers.
…cy and clarify policy counts - Updated the builder and dynamic dispatch documentation to indicate that cachekit now ships 18 implemented eviction policies, with CAR being a concrete policy not yet exposed through `CachePolicy` / `DynCache`. - Clarified the distinction between implemented policies and runtime-dispatch variants, ensuring accurate representation of the current state of the library. - Revised concurrency and trait hierarchy documentation to reflect the updated policy count, enhancing clarity for users regarding available features and capabilities. These changes improve the accuracy and comprehensiveness of the design documentation, aiding developers in understanding the current state of cachekit's policy implementations.
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
1 participant
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.
Description
Related Issue
Fixes #
Type of Change
How Has This Been Tested?
Test environment:
Checklist
cargo fmtandcargo clippycargo test)Screenshots (if applicable)
Additional Notes