Skip to content

Widen Chronicle client-docs tabs to real TypeScript parity#41

Open
woksin wants to merge 1 commit into
mainfrom
chore/chronicle-client-docs-parity
Open

Widen Chronicle client-docs tabs to real TypeScript parity#41
woksin wants to merge 1 commit into
mainfrom
chore/chronicle-client-docs-parity

Conversation

@woksin

@woksin woksin commented Jul 5, 2026

Copy link
Copy Markdown

Added

  • Real TypeScript examples in the shared Chronicle docs everywhere the SDK already supports it (events, reactors, reducers, projections, constraints, compliance, subscriptions, seeding, materialized pagination, event migrations, dynamic tags, correlation/identity/causation, and more), instead of falling back to C#-only tabs.
  • A shared Jobs and Webhooks page in the main Chronicle docs — previously undocumented anywhere except Elixir and TypeScript's own client pages, at inconsistent depth.
  • Explicit "not supported yet" notes on shared doc tabs for confirmed genuine TypeScript gaps (including several fluent-builder methods that type-check but throw at runtime), so missing coverage is honest rather than silent.

Changed

  • Trimmed TypeScript client-specific pages that duplicated shared concept explanations (correlation, identity, auditing, sinks, jobs, webhooks) down to cross-links into the shared docs, keeping the genuinely TypeScript-specific reference content.

Chronicle's shared docs previously fell back to C#-only tabs in many places
because TypeScript coverage was never written, not because the SDK lacked
the capability. Add real, source-verified TypeScript snippets everywhere an
equivalent API exists (events, reactors, reducers, projections, constraints,
compliance, subscriptions, seeding, materialized pagination, event
migrations, dynamic tags, correlation/identity/causation, and more), and add
explicit "not supported" stubs for the confirmed genuine gaps (including
several fluent-builder methods that type-check but throw
'not implemented yet' at runtime) so every tab is either real or honestly
scoped, never silently missing.

Also trims TypeScript client-specific pages that duplicated shared concept
explanations (correlation, identity, auditing, sinks, jobs, webhooks) down
to cross-links into the shared docs, and adds a shared Jobs/Webhooks page
(previously undocumented anywhere but Elixir and TypeScript's own client
pages, at inconsistent depth).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant