Skip to content

Commit a87260d

Browse files
authored
docs(ai-migration): make the v14 → v15 guide agent-ready and add BC-079..BC-084 (#3377)
Ticket: https://linear.app/stream/issue/REACT-1307 ## Goal Make the v14 → v15 guide the input of a prebuilt migration prompt: a coding agent gets one URL plus the user's repo and has to migrate accurately. ## Implementation details **`ai-docs/ai-migration-v14-v15.md`, restructured for agents.** Section numbers and existing anchors are unchanged. - Rules for the agent, and companion documents with raw URLs: the new stream-chat v9 → v10 agent guide, the JS reference, this reference and the i18n guide. - A phased workflow, a definition of done and a report template. - A detection block keyed on v14 names. It searches the whole repo, including CSS, `package.json`, CI files and `.nvmrc`. - A quick reference of about 80 rows. - A Detect column on all rows of the "Breaks that do not fail to compile" table, plus 6 new rows. - A closing Verification section, placed before the index: - a leftover-identifier grep over about 150 v14 names, plus a CSS grep; - single-copy checks for `stream-chat`, `@stream-io/state-store` and `dayjs`; - a runtime smoke list. **`ai-docs/v15-breaking-changes.md`: missed changes added since #3346** (numbered from BC-079: master's BC-078 is the `CustomCommandData` / `DefaultCommandData` removal) - BC-079: `useUserRole().canEdit` is now the permission alone. - BC-080: edit, copy and download rules moved onto `defaultMessageActionSet` items as `isVisible`. - BC-081: the quote renders above a poll; poll messages get the `--has-poll` class. - BC-082: custom preview slots mount only while their preview is visible. - BC-083: message action handlers reject on failure (#3360, #3362). - BC-084: the first-message padding is removed (#3370). - Explicit `bc-NNN` anchors; the index's links did not resolve before. The guide's index and the reference now hold the same 84 IDs. **Corrections** - Reconnect: `client.connectionRecovery` reloads the active channels and threads. The guide now warns that reloading again on `connection.recovered` reloads twice. - The §9 typing slice is `Record<string, EventPayload<'typing.start'>>`, so the type guard is gone. - rc pins and rc history are removed. **Other files** - `ai-docs/ai-migration.md` (v13 → v14) has a one-line banner pointing to the v14 → v15 guide. - `AGENTS.md`: the stale "Per-component request-handler props removed" reference now links to `#14-request-handlers`. ## How it was checked - Every identifier in the guide was checked against `src`, stream-chat-js `release-v10` and `@stream-io/i18n` / `state-store`. No stale or invented name remains on the "after" side. - All links resolve: 99 internal links in the guide, 84 in the reference, and the 5 links to stream-chat-js anchors. - The detection and leftover greps were run on a synthetic v14 app and on `examples/`. - The new snippets type-check, and prettier passes. ## Notes - The raw link to the stream-chat-js guide resolves once its PR is merged into `release-v10`. - The local `node_modules/stream-chat` is rc.28, while `package.json` wants rc.29. ## UI Changes None (docs only). ## Related PRs The three guides link to each other; review together: - stream-chat-js: GetStream/stream-chat-js#1984 (merge first: the React and RN guides link to its raw URL) - stream-chat-react: #3377 - stream-chat-react-native: GetStream/stream-chat-react-native#3918 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## Summary by CodeRabbit * **Documentation** * Clarified which version upgrades are covered by the migration guide and linked readers to the guide for upgrading from v14 to v15. * Updated the breaking-changes reference with newly documented changes and clarified that active channels reload through the client after reconnect. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 6ac68dd commit a87260d

4 files changed

Lines changed: 752 additions & 191 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ Some components also take component props for their own parts — `Attachment` (
161161

162162
When adding a customizable component: add the slot to `ComponentContextValue` (`src/context/ComponentContext.tsx`), provide a default implementation, and read it through `useComponentContext()`.
163163

164-
Request customization is not a component prop either: `sendMessageRequest`, `updateMessageRequest`, `deleteMessageRequest` and `markReadRequest` handlers are registered on `client.config` (see "Per-component request-handler props removed" in `ai-docs/ai-migration-v14-v15.md`).
164+
Request customization is not a component prop either: `sendMessageRequest`, `updateMessageRequest`, `deleteMessageRequest` and `markReadRequest` handlers are registered on `client.config` (see [section 14, "Request handlers"](ai-docs/ai-migration-v14-v15.md#14-request-handlers) of the v14 → v15 migration guide).
165165

166166
### `useStateStore` requires a selector
167167

0 commit comments

Comments
 (0)