connectrpc.com
connectrpc.com copied to clipboard
Backlog for Connect-ES documentation
- [x] Clients: Document the
timeoutMsoption: How to catch; Interop with gRPC; Code deadline_exceeded. - [ ] Clients: Document common use cases for interceptors.
- [x] Web clients: Document how to set fetch properties in the interceptors section.
- [x] Web clients: Document how to bring your own
fetch. - [ ] Web clients: Document how to debug RPCs in the browser's network explorer.
- [x] Clients: Link to the custom client example from the roll your own client section.
- [x] Clients: Document context values (see v1.1.0 release notes)
- [ ] Servers: Document context values (see v1.1.0 release notes)
- [ ] Servers: Document Connect timeouts (see connect-es#591).
- [ ] Servers: Add guide on how to handle errors, document behavior of
yieldin service implementations. - [x] Servers: Document JSON and binary options (Any and JSON).
- [ ] Servers: Document the shutdownSignal option (also see connect-es#802).
- [ ] Node.js clients: Document best practices for client-streaming and bidi RPCs, explain async iterables, show createWritableIterable().
- [ ] Node.js: Document compressions settings for clients and servers, including read/write limits.
- [ ] Node.js: Document H2 session management (see connect-es#673, https://github.com/connectrpc/connect-es/issues/1276).
- [ ] Node.js: Document how to work with errors in the vain of how Connect-Go has its own errors page for returning errors from services.
- [ ] Node.js: Document how to pin certificates and other typical gRPC use cases (see connect-es#1396).
FYI: https://grpc.io/docs/guides/deadlines/#deadline-propagation
Hey team, it would be great if you guys worked more on documentation. Thanks for all your effort