docs(lotus): LOTUS.md: the io.lotus.* widget protocol, URL flags and release flow (#43) #53

Merged
jared merged 1 commits from docs/lotus-protocol into lotus 2026-10-18 07:49:15 -04:00
Owner

Fixes #43.

New LOTUS.md at the repo root:

  • URL flags: lotusCallState, lotusTheme, lotusTransparent, lotusHostControls, lotusFrameScreenshare, lotusAudioInject, lotusDenoiseSource, lotusModel, lotusGate/lotusGateThreshold, lotusDenoiseFloor, lotusDenoiseBase, plus the fork's sendNotificationType=none. Each is described from its call site.
  • All 22 io.lotus.* actions, with direction, payload/meaning and whether cinny's lotus branch handles them. The table is generated from src/lotus/lotusActions.ts's doc comments, so it matches the code, and the handler column was checked by searching cinny. It shows denoise_state and audio_output_state as unhandled today; both are covered by pending cinny PRs.
  • Fork-only behaviour, and the release flow: version bump → v0.25.0-lotus.N tag → CI publishes @lotusguild/element-call-embedded → cinny pins the exact version.

Docs only. Actions added by open PRs (#50 call_error/reconnect) aren't listed until they merge.

🤖 Generated with Claude Code

https://claude.ai/code/session_017PCb59uY3UKqDqt7B6hzd5

Fixes #43. New **`LOTUS.md`** at the repo root: - **URL flags:** `lotusCallState`, `lotusTheme`, `lotusTransparent`, `lotusHostControls`, `lotusFrameScreenshare`, `lotusAudioInject`, `lotusDenoiseSource`, `lotusModel`, `lotusGate`/`lotusGateThreshold`, `lotusDenoiseFloor`, `lotusDenoiseBase`, plus the fork's `sendNotificationType=none`. Each is described from its call site. - **All 22 `io.lotus.*` actions**, with direction, payload/meaning and whether cinny's `lotus` branch handles them. The table is **generated from `src/lotus/lotusActions.ts`**'s doc comments, so it matches the code, and the handler column was checked by searching cinny. It shows `denoise_state` and `audio_output_state` as unhandled today; both are covered by pending cinny PRs. - **Fork-only behaviour**, and the **release flow:** version bump → `v0.25.0-lotus.N` tag → CI publishes `@lotusguild/element-call-embedded` → cinny pins the exact version. Docs only. Actions added by open PRs (#50 `call_error`/`reconnect`) aren't listed until they merge. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_017PCb59uY3UKqDqt7B6hzd5
jared added 1 commit 2026-10-18 01:24:23 -04:00
docs(lotus): LOTUS.md: the io.lotus.* widget protocol, URL flags and release flow (#43)
CI / Publish to Gitea npm registry (pull_request) Skipped
CI / Build embedded bundle (pull_request) Successful in 4m5s
167ffc2440
Everything the host relies on was documented only in src/lotus comments.
Add a table of the 22 io.lotus.* actions (generated from lotusActions.ts,
with direction, payload and whether cinny handles each), the URL flags,
fork-only behaviour and the release/publish steps.

Fixes #43

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017PCb59uY3UKqDqt7B6hzd5
jared merged commit 0aa543cc7d into lotus 2026-10-18 07:49:15 -04:00
Sign in to join this conversation.