Skip to content

docs: post-merge consistency sweep with new recipes#219

Merged
catgoose merged 1 commit into
mainfrom
docs/post-merge-sweep
Apr 11, 2026
Merged

docs: post-merge consistency sweep with new recipes#219
catgoose merged 1 commit into
mainfrom
docs/post-merge-sweep

Conversation

@catgoose

Copy link
Copy Markdown
Owner

Summary

  • Spot-checked all docs for stale control-event descriptions -- existing docs (README, stream-contract.md, delivery-observability.md, snapshot-replay.md) were already consistent with structured JSON payloads
  • Added SubscriberTopics() API mention to README subscriber management section
  • Trimmed README "App-shell lifeline architecture" section to a brief summary + links to docs/stream-contract.md, Recipe 27, and Recipe 31 (was duplicating the full contract)
  • Added 4 new recipes to RECIPES.md:
    • Recipe 29: Interaction insulation for hot-region commands -- Go handler + tavern-js delegated commands with tavern-command-delegate/tavern-command-target
    • Recipe 30: Consuming structured control events in app code -- tavern-js DOM events + raw SSE EventSource listeners for all control event payloads
    • Recipe 31: App-shell with lifeline and scoped streams -- complete app-shell with lifeline handler, navigation handler, scoped panel, AddTopic/RemoveTopic, and client-side tavern:topics-changed handling
    • Recipe 32: Stale/degraded/live region handling -- full state machine, HTML with tavern-stale-class/tavern-live-class, CSS, Go server config, and programmatic hooks

Test plan

  • go test ./... passes
  • Verify doc links resolve correctly
  • Review recipe code examples for accuracy

Closes #218

@catgoose catgoose merged commit 84b6fe6 into main Apr 11, 2026
1 check failed
@catgoose catgoose deleted the docs/post-merge-sweep branch April 11, 2026 02:12
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.

docs: sweep core docs for post-merge control-event consistency

1 participant