docs: give every published package a README - #196
Merged
Merged
Conversation
Both providers published with no README at all - npm answered "No README data found!" on each of their pages, which reads as abandoned for packages someone is being asked to put in front of their database. The memory provider's page leads with the thing people get wrong: it is per-process, so two instances cache independently and a purge on one does not reach the others. The redis one covers the connection relationship with @strapi-community/plugin-redis, matching keysPrefix to the client's keyPrefix, and that KeyDB and Valkey work unchanged. The plugin's own package README was separately stale - it still described the package as BETA, claimed support "as of September 2025", offered a filesystem provider that does not exist, listed none of the features added since 5.0.0, and linked LICENSE.md, which is not the filename. npm renders that file, so it was the most-read stale page we had. It now tracks the root README, with the screenshot and links absolutised since npm cannot resolve repository-relative paths. Verified the READMEs are actually in the published tarballs rather than excluded by `files: ["dist"]`.
This branch is three package READMEs. It also carried four files from the in-progress Cache-Control work (#175) - the e2e suite and the playground fixtures it needs - but not the implementation, so every e2e job failed on tests for a feature that is not on this branch. Those files now live on feat/cache-control with the implementation. Co-Authored-By: Claude <noreply@anthropic.com>
This was referenced Aug 14, 2026
Closed
Merged
Merged
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.
Both providers published with no README at all — npm answers "No README data found!" on each page. That reads as abandoned, for packages someone is being asked to put in front of their database.
Memory provider leads with the thing people get wrong: it's per-process, so two instances cache independently and a purge on one doesn't reach the others.
Redis provider covers the connection relationship with
@strapi-community/plugin-redis, matchingkeysPrefixto the client'skeyPrefix(a mismatch silently makes every purge a no-op), Redis Cluster behaviour, and that KeyDB/Valkey work unchanged.The plugin's own README was stale too
That's the one npm renders, so it was the most-read stale page we had. It still:
LICENSE.md, which isn't the filenameIt now tracks the root README, with the screenshot and links absolutised since npm can't resolve repository-relative paths.
Verified the READMEs actually land in the published tarballs rather than being excluded by
files: ["dist"].🤖 Generated with Claude Code