docs(#93): add websocket middleware documentation for app developers and contributors - #106
Merged
Merged
Conversation
…and contributors Adds the Diataxis EXPLANATION pair for issue #93, following the established docs/ pattern (see #90-#92, #94, #96): - docs/websocket-middleware-app-dev.md — connection status, sending messages, event handlers, and reconnection behavior from the consuming app's point of view. - docs/websocket-middleware-contributors.md — internal architecture of createWebSocketMiddleware: connect flow, close-code handling table, reconnection loop, anti-flash delay, message routing, and the reactive room-status listeners. Flags an open question (Needs Verification callout) about whether the setWebsocketIsConnected/ setRoomData room-status listeners actually fire, since their requestRoomStatus() calls omit the roomKey argument the guard checks. Also supersedes three point-in-time PR-description docs at the repo root (WEBSOCKET_RECONNECTION.md, WEBSOCKET_REFACTOR_SUMMARY.md, AUTOMATIC_ROOM_STATUS_IMPLEMENTATION.md) whose close-code and endpoint details had drifted from the current implementation. Replaced their content with pointers into the new contributor doc so existing links don't 404; their per-scenario manual test checklists described a prior implementation and were dropped rather than carried forward. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds maintained WebSocket middleware documentation for both consuming app developers and contributors, and converts older root-level WebSocket/room-status docs into short redirect stubs to avoid duplicated / drifting guidance.
Changes:
- Added
docs/websocket-middleware-contributors.mdcovering middleware internals, lifecycle, and extension points. - Added
docs/websocket-middleware-app-dev.mdcovering the app-facing API (useWsIsConnected,useWebsocketContext) and expected reconnection behavior. - Replaced legacy root-level documents with brief redirects pointing to the new docs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| WEBSOCKET_REFACTOR_SUMMARY.md | Replaced historical summary with redirect to the new maintained docs. |
| WEBSOCKET_RECONNECTION.md | Replaced drifted reconnection details with a redirect to the maintained contributor doc section. |
| AUTOMATIC_ROOM_STATUS_IMPLEMENTATION.md | Replaced historical room-status description with redirect to the maintained contributor doc section. |
| docs/websocket-middleware-contributors.md | New contributor-focused reference describing middleware architecture and behavior. |
| docs/websocket-middleware-app-dev.md | New app-developer guide describing connection status, messaging, events, and reconnection expectations. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
ndorin
approved these changes
Aug 26, 2026
|
🎉 This PR is included in version 1.25.0-add-zoom.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.24.1-cache-busting.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 1.25.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
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.
Summary
Adds websocket middleware documentation for app developers and contributors, and trims the now-redundant content out of the legacy root-level docs.
docs/websocket-middleware-app-dev.md— how the websocket middleware works, for app developersdocs/websocket-middleware-contributors.md— guide for contributors extending the websocket middlewareAUTOMATIC_ROOM_STATUS_IMPLEMENTATION.md,WEBSOCKET_RECONNECTION.md,WEBSOCKET_REFACTOR_SUMMARY.mdnow that it lives in the new docsCloses #93
🤖 Generated with Claude Code