Document SSR removal release impact

Author: zth

.changeset/remove-ssr-streaming.md

@@ -0,0 +1,7 @@
+---
+"rescript-relay-router": major
+---
+
+Migrate the package to ReScript 12/Rewatch and remove the unused SSR streaming stack.
+
+Projects must use ReScript 12, regenerate router output, and no longer import the removed `./server` package export or SSR streaming helpers. Removed APIs include the server Vite plugin, manifest transform, `RelayRouter.Manifest`, `RelayRouter.PreloadInsertingStream`, and the SSR preload insertion utilities.

packages/rescript-relay-router/README.md

@@ -20,12 +20,13 @@ A router designed for scale, performance and ergonomics. Tailored for usage with
 The router requires the following:
 
 - `rescript@>=12.0.0`
-- `vite` for your project setup, `>2.8.0`.
+- `react@>=18.2.0`
+- `vite@>=4.4.9` for your project setup.
 - [`build: { target: "esnext" }`](https://vitejs.dev/config/#build-target) in your `vite.config.js`.
 - `"type": "module"` in your `package.json`, meaning you need to run in es modules mode.
 - Your Relay config named `relay.config.cjs`.
 - Preferably `yarn` for everything to work smoothly.
-- `rescript-relay@>=1.1.0`
+- `rescript-relay@>=3.0.0`
 
 Install the router and initialize it:
 
@@ -40,7 +41,7 @@ yarn rescript-relay-router init
 yarn rescript-relay-router generate -scaffold-renderers
 ```
 
-This will create all necessary assets to get started. Now, add the router to your `bsconfig.json`:
+This will create all necessary assets to get started. Now, add the router to your `rescript.json`:
 
 ```json
 "dependencies": [

packages/rescript-relay-router/package.json

@@ -41,7 +41,7 @@
   "bin": "cli/RescriptRelayRouterCli.bundle.mjs",
   "peerDependencies": {
     "@rescript/react": ">=0.13.0",
-    "react": ">=19.2.0",
+    "react": ">=18.2.0",
     "rescript-relay": ">=3.0.0",
     "vite": ">=4.4.9"
   },

yarn.lock

@@ -5706,7 +5706,7 @@ __metadata:
     vscode-jsonrpc: ^5.0.1
   peerDependencies:
     "@rescript/react": ">=0.13.0"
-    react: ">=19.2.0"
+    react: ">=18.2.0"
     rescript-relay: ">=3.0.0"
     vite: ">=4.4.9"
   bin: