From 39fd2a9f8074266c29d98af38e3c98ccbd1ccaaf Mon Sep 17 00:00:00 2001 From: Danijel Martinek Date: Sat, 9 May 2026 13:46:41 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20realtime=20now=20optional=20=E2=80=94?= =?UTF-8?q?=20Status=20headers=20+=20conditional=20HTML=20rendering?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/architecture/data-flow-explainer.html | 2 +- docs/decisions/adr-016-realtime-layer.md | 2 +- docs/guides/realtime.md | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/architecture/data-flow-explainer.html b/docs/architecture/data-flow-explainer.html index 7d81a4c..d096ba8 100644 --- a/docs/architecture/data-flow-explainer.html +++ b/docs/architecture/data-flow-explainer.html @@ -2192,7 +2192,7 @@ footer .colophon {
di/bind-production.ts

Production binder

-

bindProduction<F>(ctx: BindProductionContext) — unbinds the mock, rebinds the real Payload-backed impl. The ctx arg carries required fields (tracer, logger, config) and optional cross-cutting deps (bus, queue, realtime, realtimeRegistry).

+

bindProduction<F>(ctx: BindProductionContext) — unbinds the mock, rebinds the real Payload-backed impl. The ctx arg carries required fields (tracer, logger, config) and optional cross-cutting deps (bus, queue). Realtime deps (realtime, realtimeRegistry) are also optional — present only when @repo/core-realtime is scaffolded via pnpm turbo gen core-package realtime.

Pros
  • Decouples Payload config from the feature package — boundary stays clean
  • diff --git a/docs/decisions/adr-016-realtime-layer.md b/docs/decisions/adr-016-realtime-layer.md index 0055eb0..c14a326 100644 --- a/docs/decisions/adr-016-realtime-layer.md +++ b/docs/decisions/adr-016-realtime-layer.md @@ -1,6 +1,6 @@ # ADR-016 — Realtime layer (Socket.IO) -**Status:** Accepted +**Status:** Optional — scaffold via `pnpm turbo gen core-package realtime`. The package is not in the default template; this ADR documents the design that the generator emits. **Date:** 2026-05-08 **Spec:** docs/superpowers/specs/2026-05-08-realtime-design.md **Plan:** docs/superpowers/plans/2026-05-08-realtime-layer.md diff --git a/docs/guides/realtime.md b/docs/guides/realtime.md index b4b24c1..4cbe40a 100644 --- a/docs/guides/realtime.md +++ b/docs/guides/realtime.md @@ -1,5 +1,7 @@ # Realtime +> **Prerequisite:** This guide assumes `@repo/core-realtime` is present. If you started from the slim template, run `pnpm turbo gen core-package realtime` first. + Walkthrough for adding Socket.IO realtime channels, broadcasts, and inbound handlers to a feature. For the architectural rationale, see [ADR-016](../decisions/adr-016-realtime-layer.md) and [the full spec](../superpowers/specs/2026-05-08-realtime-design.md). The three rules to keep in mind: