docs: explain why gRPC helps for streaming#3
Merged
Conversation
The README leads with "gRPC-native" but never says why that matters. Add a "Why gRPC for streaming" section contrasting the native gRPC surface with the OpenAI-compatible HTTP/SSE endpoint most clients use: typed chunks (no SSE frame parsing or [DONE] sentinel), structured end-of-stream status via HTTP/2 trailers, real context cancellation, and connection multiplexing. Kept honest — notes SSE is fine for simple one-directional token streaming. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
The README leads with "gRPC-native" but never explains the payoff. Adds a Why gRPC for streaming section contrasting the native gRPC surface with the OpenAI-compatible HTTP/SSE endpoint most Grok clients use:
data:frame splitting, partial-JSON reassembly, or[DONE]sentinelstatus.Code, cleanio.EOF)contextcancellation (HTTP/2 stream reset) + deadline propagationKept deliberately honest — notes SSE is perfectly fine for simple one-directional token streaming, so it reads as engineering rather than marketing.
🤖 Generated with Claude Code