connectrpc / connectrpc/connectrpc.com

Backlog for Connect-ES documentation

Open
#41 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
40
Forks
27
Avg merge
7d 1h
Merged PRs (30d)
10

Description

  • Clients: Document the timeoutMs option: How to catch; Interop with gRPC; Code deadline_exceeded.
  • Clients: Document common use cases for interceptors.
  • Web clients: Document how to set fetch properties in the interceptors section.
  • Web clients: Document how to bring your own fetch.
  • Web clients: Document how to debug RPCs in the browser's network explorer.
  • Clients: Link to the custom client example from the roll your own client section.
  • 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 yield in service implementations.
  • 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).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Choose one unchecked documentation item rather than taking on the whole backlog. Start by reading the relevant existing Connect-ES docs section and any linked issue or pull request, then define completion as a focused guide covering that topic with the requested examples and behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
node.js
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.