Skip to content

Docs: rewrite compatibility and migration for users#124

Merged
nerdchanii merged 1 commit into
mainfrom
codex/issue-119-user-facing-compatibility-migration
May 28, 2026
Merged

Docs: rewrite compatibility and migration for users#124
nerdchanii merged 1 commit into
mainfrom
codex/issue-119-user-facing-compatibility-migration

Conversation

@nerdchanii

Copy link
Copy Markdown
Owner

Summary

  • rewrite the compatibility page around supported package pairings and package ownership
  • rewrite migration as practical upgrade guidance instead of maintainer release process notes
  • keep the current version information accurate for react-socket-store@0.0.5 and socket-store@^0.0.3

Type

  • API
  • Runtime
  • Testing
  • Docs
  • Tooling
  • Packaging/release

Priority

  • P0 - Critical
  • P1 - High
  • P2 - Medium
  • P3 - Low
  • P4 - Backlog

Verification

  • Tests added or updated
  • Typecheck passes
  • Build passes
  • Docs/examples updated if needed

Release Intent

  • Changeset added
  • No release needed (docs/project-only or tooling-only and does not affect consumers)

Notes

Related issue: Closes #119

Verification:

  • npm run docs:build
  • npm run lint

@nerdchanii

Copy link
Copy Markdown
Owner Author

@codex review

Context:

@nerdchanii nerdchanii marked this pull request as ready for review May 28, 2026 20:31
@nerdchanii nerdchanii merged commit 0255302 into main May 28, 2026
2 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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. |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P3 Badge 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 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Rewrite compatibility and migration as user-facing docs

1 participant