docs: event vocabulary freeze + operator runbook + simulate happy-path

[arkadianet]

What

The three remaining documentation deliverables from the operator workload (A2-freeze, B5, E):

1. docs/events.md — the event vocabulary, frozen. Every coarse-feed kind (blockApplied → shadowDivergence) with its fields, the WS channel table (live vs channel_unavailable, terminal tx:/box: semantics), seq/resume/backfill semantics (8192-event window, 1024 resume cap, truncated ⇒ resync, exactly-once across the replay/live seam), and transport limits. Compatibility contract stated: additive changes only.
2. Operator runbook (operating.md): a symptom → decisive-metrics table for "it looks stuck" — apply-in-progress vs rejection-loop vs download-starvation vs isolation vs shadow-divergence vs wedge, each resolvable from /metrics + one status field. This makes the B-workstream promise ("no false stall signal without a companion gauge") operationally queryable.
3. One dry-run path (operating.md): transactions/simulate is THE whole-tx validation path; script/* is the contract-developer playground. Discoverability fix only — no new surface.

Docs-only PR; facts cross-checked against the code (channel liveness from RealtimeBus::blocks_and_mempool, caps from RESUME_WINDOW/RESUME_MAX/MAX_MESSAGE_BYTES, event names from the model builders).

🤖 Generated with Claude Code

https://claude.ai/code/session_01BUh2DBnAPqThdYFZW5D8wx

Summary by CodeRabbit

• Documentation
  • Added a complete specification for operator events, including REST and WebSocket delivery, event types, subscriptions, retention, replay, and connection limits.
  • Documented the recommended transaction simulation workflow and clarified how it differs from the script playground.
  • Added a troubleshooting runbook for diagnosing stalled operations, sync issues, and Shadow divergence using available metrics.

[coderabbitai]

Warning

Review limit reached

@arkadianet, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 54 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: bf92ad26-b6f9-49b5-ae48-87bdae4b546c

📥 Commits

Reviewing files that changed from the base of the PR and between 5f6dec5 and 67890e6.

📒 Files selected for processing (2)

• docs/events.md
• docs/operating.md

📝 Walkthrough

Walkthrough

Adds documentation for operator event APIs and WebSocket delivery semantics, plus runbook guidance for transaction simulation and diagnosing stalled or divergent operation.

Changes

Operator documentation

Layer / File(s)	Summary
Event feeds and delivery semantics docs/events.md	Specifies REST and WebSocket event vocabularies, channels, fields, retention, replay, sequencing, and transport limits.
Simulation and stalled-operation runbooks docs/operating.md	Documents transaction simulation versus the script playground and maps stall-like symptoms to diagnostic metrics and endpoints.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• arkadianet/ergo#152: Implements the events endpoint and payload shape documented by this change.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately reflects the documentation-only changes: event vocabulary, operator runbook, and transaction simulation guidance.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/operator-polish

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/events.md`:
- Around line 69-73: Update the heartbeat description in the events
documentation to specify the exact client response frame required by the
protocol, and state that the client must send it within the server’s idle window
of roughly two heartbeat intervals (about 30 seconds) to keep the socket open.
- Around line 10-15: Clarify the sentence beginning “Both derive from the same
snapshot differ” to explicitly identify the REST ring and WebSocket bus as
deriving from the same snapshot-diff producer chain, preserving the existing
statement that consumers can poll to catch up and subscribe to stay current
without contradictory histories.

In `@docs/operating.md`:
- Around line 432-445: The runbook introduction incorrectly limits all decisive
signals to GET /metrics. Update the introductory description above the symptom
table to state that operators should use both Prometheus metrics and JSON status
endpoints, while preserving the existing metric and endpoint references in the
table.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 5ed1d9f1-97cd-426f-a33f-886d57bf4ee2

📥 Commits

Reviewing files that changed from the base of the PR and between adb170d and 5f6dec5.

📒 Files selected for processing (2)

• docs/events.md
• docs/operating.md