Docs: rewrite compatibility and migration for users#124
Conversation
|
@codex review Context:
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d11ebec449
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| | Future adapter release requiring new core behavior or public core types | Future npm `socket-store` release that contains that contract | Not supported until both packages are released | Do not publish or document a new adapter pairing until the required core version is available from npm and the migration notes name the minimum version. | | ||
| | `0.0.5` | `^0.0.3` | Supported current pairing | Current documented pairing. | | ||
| | `0.0.4` | `^0.0.2` | Older pairing | Upgrade when you want the latest public docs and compatibility guidance. | | ||
| | Future adapter release requiring new core behavior or public core types | Matching future `socket-store` npm release | Not supported yet | Wait for a documented pairing before upgrading both packages together. | |
There was a problem hiding this comment.
Remove hypothetical future pairing from user docs
This row keeps a hypothetical “Future adapter release” in the public compatibility matrix, even though #119 asks these pages to remove future planning language and focus on supported user-facing package pairings. Users scanning the table can interpret the unreleased pairing as part of the compatibility guidance instead of seeing only concrete released versions.
Useful? React with 👍 / 👎.
Summary
react-socket-store@0.0.5andsocket-store@^0.0.3Type
Priority
Verification
Release Intent
Notes
Related issue: Closes #119
Verification:
npm run docs:buildnpm run lint