Skip to content

Document WebSocket support#1065

Merged
Kludex merged 2 commits into
mainfrom
document-websockets
Jul 14, 2026
Merged

Document WebSocket support#1065
Kludex merged 2 commits into
mainfrom
document-websockets

Conversation

@Kludex

@Kludex Kludex commented Jul 14, 2026

Copy link
Copy Markdown
Member

Documents the native WebSocket support added in #1042, following the same structure as the SSE docs (#1050):

  • New docs/websockets.md guide covering opening sessions, sending/receiving messages, subprotocols, keepalive pings, configuration, error handling, and testing ASGI applications with ASGIWebSocketTransport.
  • WebSockets entry in the nav, after Server-Sent Events.
  • API reference: top-level websocket() helper, websocket member on Client/AsyncClient, and WebSocketSession/AsyncWebSocketSession sections.
  • wsproto listed in the optional dependencies on the index page.

Docs build passes with no new warnings.

AI Disclaimer

This PR was developed with the assistance of either Claude or Codex. I've reviewed and verified the changes.

Review in cubic

@github-actions

Copy link
Copy Markdown

Docs preview:

@codspeed-hq

codspeed-hq Bot commented Jul 14, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 15 untouched benchmarks
⏩ 7 skipped benchmarks1


Comparing document-websockets (ac1e562) with main (2cb02fe)

Open in CodSpeed

Footnotes

  1. 7 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

@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: 406af3865f

ℹ️ 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".

Comment thread docs/websockets.md Outdated
Comment thread docs/websockets.md Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

All reported issues were addressed across 4 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread docs/websockets.md Outdated
Comment thread docs/websockets.md Outdated
@Kludex
Kludex merged commit 95aebc3 into main Jul 14, 2026
15 checks passed
@Kludex
Kludex deleted the document-websockets branch July 14, 2026 10:43
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.

1 participant