Skip to content

docs(service-communication): reference — choosing a communication mechanism#51

Merged
intech merged 1 commit into
mainfrom
docs/communication-mechanisms-reference
Jun 24, 2026
Merged

docs(service-communication): reference — choosing a communication mechanism#51
intech merged 1 commit into
mainfrom
docs/communication-mechanisms-reference

Conversation

@intech

@intech intech commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

What

A new capstone reference page — Choosing a Communication Mechanism — that puts Connectum's three orthogonal cross-service mechanisms side by side and helps a reader pick the right one for each interaction (no existing page covers this decision):

Mechanism Use it when
ctx.call / ctx.stream (synchronous) you need the answer now to proceed
EventBus (fire-and-forget) you announce a fact and let consumers react
durable saga (Temporal) a multi-step transaction that must roll back as a unit

The page frames the decision around coupling-in-time and failure semantics (not performance), gives a decision table and a per-mechanism trade-off, shows the three composed in one flow (a Mermaid diagram), and points at the car-sharing and hris reference examples. It reinforces the framework-stays-thin stance: ctx.call and EventBus ship in the framework; durable orchestration is delegated to a best-of-breed engine (Temporal) rather than reinvented.

Registered first in the Service Communication sidebar group.

Verification

  • vitepress build is clean — all internal links resolve (VitePress fails the build on dead links), Mermaid diagrams render, the page is emitted to dist/.
  • The content is 1.0.0-safe — it describes ctx.call, the EventBus, and the saga pattern, all demonstrable on the published packages (no unpublished-1.1.0 API).

Cross-repo note

The page's three-mechanism reference to hris assumes examples #31 (the hris onboarding saga, Phase 5a) is merged; the car-sharing trip-saga reference is already on examples main. Both example links point to the main branch of the examples repo.

🤖 Generated with Claude Code

https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3

@github-actions github-actions Bot added the type:docs Documentation: guides, README, JSDoc label Jun 21, 2026
@intech intech self-assigned this Jun 23, 2026
…n mechanism

Add a capstone reference page that puts Connectum's three orthogonal
cross-service mechanisms side by side and helps pick the right one per
interaction:

- ctx.call / ctx.stream — synchronous, when you need the answer to proceed
- EventBus — asynchronous fire-and-forget, when you announce a fact
- durable saga (Temporal) — a multi-step transaction with LIFO compensation

The page frames the decision around coupling-in-time and failure semantics (not
performance), gives a decision table + a per-mechanism trade-off, shows the three
composed in one flow (a Mermaid diagram), and points at the car-sharing and hris
reference examples. It reinforces the "framework stays thin" stance: ctx.call and
EventBus ship in the framework; durable orchestration is delegated to a
best-of-breed engine rather than reinvented.

Registered first in the Service Communication sidebar group. Builds clean
(vitepress build, no dead links).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01MdeH7fExPmiRHRirGuvGk3
@intech intech force-pushed the docs/communication-mechanisms-reference branch from 27f438f to 06105f7 Compare June 24, 2026 19:51
@intech intech merged commit e41304a into main Jun 24, 2026
3 checks passed
@intech intech deleted the docs/communication-mechanisms-reference branch June 24, 2026 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type:docs Documentation: guides, README, JSDoc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant