Documentation: add section about the compiler plugin and trimming + improve readme #171
Conversation
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
martinbonnin
approved these changes
Jun 3, 2025
Comment on lines
+17
to
+27
| This repository hosts [Apollo Kotlin](https://github.com/apollographql/apollo-kotlin)'s new normalized cache, aiming to replace the main repository's version. | ||
|
|
||
| Compared to the previous version, this new normalized cache brings: | ||
|
|
||
| - [Pagination support](https://apollographql.github.io/apollo-kotlin-normalized-cache/pagination-home.html) | ||
| - [Cache control](https://apollographql.github.io/apollo-kotlin-normalized-cache/cache-control.html) (a.k.a. Time to live or expiration) | ||
| - [Garbage collection](https://apollographql.github.io/apollo-kotlin-normalized-cache/garbage-collection.html), and [trimming](https://apollographql.github.io/apollo-kotlin-normalized-cache/trimming.html) | ||
| - Partial results from the cache | ||
| - API simplifications | ||
| - Key scope support | ||
| - SQL cache improved performance |
There was a problem hiding this comment.
If you're fine with maintaining 2 sources of truth, this is fine. Else, I'm okay with a simple README that just redirects to the main documentation site.
There was a problem hiding this comment.
That's not too much trouble for now :)
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.
No description provided.