Skip to content

Conversation

jackyzha0
Copy link
Member

Why

readme is out of date

What changed

update readme, some casing consistency, more examples

Versioning

  • Breaking protocol change
  • Breaking ts/js API change

@jackyzha0 jackyzha0 requested a review from a team as a code owner October 6, 2025 21:22
@jackyzha0 jackyzha0 requested review from Monkatraz and removed request for a team October 6, 2025 21:22
Copy link

macroscopeapp bot commented Oct 6, 2025

Update documentation across README.md to reflect current APIs, examples, and configuration guidance motivated by docs update

This pull request rewrites and expands the project documentation in README.md, updates examples to current API naming and patterns, and bumps the package version in package.json.

  • Replace service creation examples to use createServiceSchema() with a local const ServiceSchema = createServiceSchema() and adjust server setup to pass a services object into createServer in README.md
  • Rename Procedure.rpc option requestErrors to responseError in examples and update feature bullets, including removing the Unix Domain Socket claim and adding OpenTelemetry integration in README.md
  • Add sections covering Error Handling with Ok/Err, Uncaught Errors behavior, Advanced Patterns for rpc, upload, subscription, and stream, Client Cancellation with AbortController and ctx.signal, Codecs usage and custom implementations, Custom Transports with example Connection/ClientTransport/ServerTransport subclasses, Testing utilities via createMockTransportNetwork, and revised Custom Handshake with createServiceSchema generics and explicit handshake schema variables in README.md
  • Update client creation examples to use generic typing createClient<ServiceSurface> and demonstrate type-only import of ServiceSurface in README.md
  • Adjust TypeScript configuration guidance to recommend compilerOptions.strict and moduleResolution bundler in README.md
  • Bump version from 0.209.7 to 0.209.8 in package.json
  • Modify redacted lockfile in package-lock.json

📍Where to Start

Start with the updated examples and API notes in the top sections of README.md, focusing on the transition to createServiceSchema() and the Procedure.rpc option rename to responseError.

Changes since #344 opened

  • Updated OpenTelemetry documentation [b5923e4]
  • Added explanatory comment to streamingExample Procedure.stream code snippet [a308bf2]
  • Updated subsection heading terminology in documentation [f013088]
  • Added clarification statement about ctx.signal behavior in documentation [ba4c8a2]

Macroscope summarized ba4c8a2.

Copy link
Member

@masad-frost masad-frost left a comment

Choose a reason for hiding this comment

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

weee

jackyzha0 and others added 4 commits October 6, 2025 15:12
Co-authored-by: Faris Masad <[email protected]>
Co-authored-by: Faris Masad <[email protected]>
Co-authored-by: Faris Masad <[email protected]>
Co-authored-by: Faris Masad <[email protected]>
@jackyzha0 jackyzha0 merged commit 012e38c into main Oct 6, 2025
10 checks passed
@jackyzha0 jackyzha0 deleted the jackyzha0/docs-update branch October 6, 2025 22:18
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.

2 participants