[claude] Document Hermes provider fallback chain (#287) #315

Merged
gemini merged 1 commits from claude/issue-287 into main 2026-03-24 04:54:28 +00:00
Member

Fixes #287

Adds comprehensive JSDoc documentation to ws-client.js covering:

  • Module overview: explains Hermes as the sovereign AI orchestration gateway and the single entry point for all AI provider responses (Claude → Gemini → Perplexity → fallback)
  • Provider fallback chain: clarifies that provider selection happens inside Hermes; the Nexus client stays connected so no provider events are dropped
  • Connection lifecycle: documents all 5 stages (connect → onopen → onmessage → onclose → _scheduleReconnect)
  • Backoff schedule: explicit table showing 1s → 2s → 4s … capped at 30s, up to 10 attempts before emitting ws-failed
  • Message queue: describes buffering behaviour during disconnects
  • CustomEvent reference table: maps all Hermes message types to their dispatched event names and payload shapes
  • Per-method @param JSDoc for IDE discoverability
Fixes #287 Adds comprehensive JSDoc documentation to `ws-client.js` covering: - **Module overview**: explains Hermes as the sovereign AI orchestration gateway and the single entry point for all AI provider responses (Claude → Gemini → Perplexity → fallback) - **Provider fallback chain**: clarifies that provider selection happens inside Hermes; the Nexus client stays connected so no provider events are dropped - **Connection lifecycle**: documents all 5 stages (connect → onopen → onmessage → onclose → _scheduleReconnect) - **Backoff schedule**: explicit table showing 1s → 2s → 4s … capped at 30s, up to 10 attempts before emitting `ws-failed` - **Message queue**: describes buffering behaviour during disconnects - **CustomEvent reference table**: maps all Hermes message types to their dispatched event names and payload shapes - **Per-method @param JSDoc** for IDE discoverability
claude added 1 commit 2026-03-24 04:54:13 +00:00
docs: document Hermes provider fallback chain in ws-client.js
Some checks failed
CI / auto-merge (pull_request) Has been skipped
CI / validate (pull_request) Failing after 12s
600c19c26a
Adds a module-level JSDoc block explaining:
- The Hermes gateway's role as the single entry point for all AI
  provider responses (Claude → Gemini → Perplexity → fallback)
- The full connection lifecycle (connect → onopen → onmessage →
  onclose → _scheduleReconnect)
- The exponential backoff schedule (1s, 2s, 4s … capped at 30s,
  up to 10 attempts, then ws-failed)
- The message queue that buffers outbound messages while disconnected
- A reference table of all dispatched CustomEvent names and payloads

Also adds @param/@returns JSDoc to each method for IDE discoverability.

Fixes #287
gemini merged commit 63aa9e7ef4 into main 2026-03-24 04:54:28 +00:00
Sign in to join this conversation.