[SLOP(claude-opus-4-8)] docs(examples): split effect example into hello-world-effect and chat-room-effect

[NathanFlurry]

No description provided.

[NathanFlurry]

Stack for rivet-dev/rivet

• [SLOP(gpt-5)] feat(cli): add rivetkit cli #5255 kprpzusk · 2026-06-13 23:00:59
• [SLOP(claude-opus-4-8[1m]-medium)] docs(website): consolidate landing pages, deploy quickstarts, and docs restructuring #5254 psyxxqon · 2026-06-13 23:00:58
• [SLOP(claude-opus-4-8)] refactor(rivetkit): deprecate actor kv api across core and typescript #5253 polvovvk · 2026-06-13 23:00:57
• [SLOP(claude-opus-4-8)] docs(examples): split effect example into hello-world-effect and chat-room-effect #5252 wolqzmyo · 2026-06-13 23:00:56 👈
• [SLOP(gpt-5)] fix(rivetkit): normalize protocol args source-side #5251 lvpxytwl · 2026-06-13 00:10:46
• [SLOP(claude-opus-4-8)] docs(actors): apply docs audit fixes #5250 rtqklwqu · 2026-06-13 00:10:45
• [SLOP(claude-opus-4-8)] docs(actors): rewrite in-memory state page, remove sandbox page, fix stateSaveInterval default, forbid em dashes #5249 pqwwounv · 2026-06-13 00:10:44
• [SLOP(claude-opus-4-8-medium)] docs(pool-configuration): fix runner-config SDK snippet to use RivetClient from engine-api-full #5248 tmoxrznq · 2026-06-13 00:10:42
• [SLOP(claude-opus-4-8-medium)] docs(inspector-tabs): mark illustrative type-shape snippets as @nocheck #5247 yosxkyox · 2026-06-13 00:10:41
• [SLOP(claude-opus-4-8-medium)] docs(quickstart): clean up rust quickstart to import shared actor and auto-download engine #5246 lrzpsprl · 2026-06-13 00:10:40
• [SLOP(claude-opus-4-8-medium)] fix(rivetkit-wasm): add missing inspector_tabs field to ActorConfigInput conversion #5245 ookuputp · 2026-06-13 00:10:39
• main

Get stack: forklift get 5252
Push local edits: forklift submit
Merge when ready: forklift merge 5252

[claude]

Code Review: Split effect example into hello-world-effect and chat-room-effect

Overview

This PR renames examples/effect → examples/chat-room-effect (the complex multi-actor example) and adds a new examples/hello-world-effect (a minimal counter). Both examples gain Vitest test suites, and a new Effect.ts quickstart doc page is added at /docs/actors/quickstart/effect.

---

Issues

Dual top-level execution in hello-world-effect/src/main.ts

The file runs Layer.launch(MainLayer).pipe(NodeRuntime.runMain) and evaluates export const { handler, dispose } = Registry.toWebHandler(...) at the top level. When tsx src/main.ts is invoked (as in the dev/start scripts), both execute, potentially creating two registry instances. The intent seems to be showing an alternative pattern for serverless, but as written a developer copy-pasting this will end up with both running. Extract the web-handler export into a separate comment block or a separate file to avoid the confusion.

Hardcoded actor keys in counter tests

hello-world-effect/tests/counter.test.ts uses fixed keys ("t-increment", "t-iso-a", "t-iso-b"). Against a persistent engine these keys will carry state from previous runs, making the increment assertion === 1 flaky on a second run. The chat-room-effect tests solve this correctly with the freshRoom helper that appends a random UUID. Apply the same pattern here:

const freshCounter = Effect.gen(function* () {
    return (yield* Counter.client).getOrCreate(`counter_${yield* Random.nextUUIDv4}`);
});

Inconsistent key format in documentation

In the quickstart doc, the Effect client calls counterClient.getOrCreate("my-counter") (string), while the TypeScript tab calls client.Counter.getOrCreate(["my-counter"]) (array). Readers comparing the two tabs will be confused about when to use which form. Unify or add a note explaining the difference.

---

Minor observations

• @nocheck on doc code blocks: Adding @nocheck to every TypeScript snippet in the MDX file disables type checking. Inline examples with @nocheck won't catch future API drift. Consider removing it and fixing any type errors instead, or at least limiting it to tabs where the type is genuinely unresolvable in a standalone snippet.

• Missing events test in hello-world-effect: The README and quickstart both highlight events (rawRivetkitContext.broadcast) as a feature, but no test covers the event path. A test that subscribes to newCount and asserts it fires on Increment would close the gap and serve as runnable documentation.

• rawRivetkitContext without explanation: The wake-function signature { rawRivetkitContext, state } will surprise Effect users since broadcast escapes the Effect layer. A one-line comment in the example noting why this is an escape hatch (events aren't yet lifted to Effect-native APIs) would reduce confusion.

---

What looks good

• The contract/implementation split (api.ts vs live.ts) is a clean pattern and is well-explained in both the READMEs and the quickstart doc.
• The freshRoom helper in chat-room-effect tests correctly isolates state across cases.
• Vitest + @effect/vitest versions are consistent across both examples.
• Sitemap is updated with the new page as required.
• The Rust quickstart badge upgrade from Preview → Beta is a clean fix alongside the new Effect addition.
• hello-world-effect/package.json correctly sets "skipVercel": true to opt out of the Vercel mirror.