connectrpc / connectrpc/connectrpc.com
Docs: update stream error FAQ
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 40
- Forks
- 27
- Avg merge
- 7d 1h
- Merged PRs (30d)
- 10
Description
Hi!
I encountered an error on a server stream call that is not well documented. The full discussion is here: https://github.com/connectrpc/connect-go/discussions/757
To summarize, the WriteTimeout on the http.Server caused me this error after the timeout: invalid_argument: protocol error: incomplete envelope: unexpected.
Should we update the documentation here to mention that?
Thanks.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the FAQ entry at https://connectrpc.com/docs/faq/#stream-error and read the linked Connect Go discussion for the reported behavior. Update the stream-error FAQ to mention that http.Server WriteTimeout can produce this incomplete-envelope error, then verify the documentation renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 58/100