Skip to content

Commit decd831

Browse files
authored
docs: drop // Ref comment rule from CLAUDE.md (#1372)
1 parent 9e9148c commit decd831

1 file changed

Lines changed: 4 additions & 21 deletions

File tree

CLAUDE.md

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ pnpm build && node ./examples/src/test_my_plugin.ts
6363
The core of the framework. Pipeline flow: **Audio In → VAD → STT → LLM → TTS → Audio Out**.
6464

6565
Key classes and their roles:
66+
6667
- **`Agent`** — Base class holding instructions, tools, and model config. Subclass to override pipeline hooks (`ttsNode`, `realtimeAudioOutputNode`, `sttNode`, `llmNode`). Use `voice.Agent.default.<hook>(this, ...)` to call the base implementation from overrides.
6768
- **`AgentTask`** — Extends Agent for composable task workflows with isolated chat context and tool scoping.
6869
- **`AgentSession`** — Orchestrates the full session lifecycle: connects to LiveKit room, manages turn detection, handles interruptions, collects metrics. Entry point: `session.start({ agent, room })`.
@@ -105,6 +106,7 @@ Wire protocol for distributed agents via LiveKit room message channels. `Session
105106
Each extends `Plugin` base class, auto-registers on import via `Plugin.registerPlugin()`. Pattern: `@livekit/agents-plugin-<provider>`.
106107

107108
Plugin capabilities by type:
109+
108110
- **LLM**: openai, google, baseten
109111
- **STT**: deepgram (v1+v2), openai, baseten, sarvam (v1/v2/v3)
110112
- **TTS**: cartesia, elevenlabs, deepgram, openai, neuphonic, resemble, rime, inworld, baseten, sarvam (v1/v2/v3)
@@ -117,6 +119,7 @@ Plugin capabilities by type:
117119
### AsyncLocalStorage Patterns
118120

119121
The framework uses Node.js `AsyncLocalStorage` for implicit context passing:
122+
120123
- `agentActivityStorage` — Access current `AgentActivity` in callbacks
121124
- `functionCallStorage` — Access current `FunctionCall` in tool handlers
122125
- `speechHandleStorage` — Access current `SpeechHandle`
@@ -149,27 +152,7 @@ The framework uses Node.js `AsyncLocalStorage` for implicit context passing:
149152

150153
When porting features or fixes from the Python `livekit-agents` repo to this JS/TS repo, follow these rules:
151154

152-
### 1. Python reference comments (`// Ref`)
153-
154-
Every JS change that corresponds to a Python change must carry an inline reference comment directly above the relevant line(s):
155-
156-
```ts
157-
// Ref: python <relative-file-path> - <line-range> lines
158-
```
159-
160-
Examples:
161-
162-
```ts
163-
// Ref: python livekit-agents/livekit/agents/voice/agent_session.py - 362-369 lines
164-
private _aecWarmupRemaining = 0;
165-
166-
// Ref: python livekit-agents/livekit/agents/voice/agent_activity.py - 1236-1240 lines
167-
if (this.agentSession._aecWarmupRemaining > 0) { ... }
168-
```
169-
170-
Use the Python file path relative to the repo root. Include the line range from the Python diff so reviewers can cross-reference directly.
171-
172-
### 2. Time unit unification
155+
### Time unit unification
173156

174157
Python uses **seconds** (`float`) for all time values. JS/TS uses **milliseconds** (`number`) by default.
175158

0 commit comments

Comments
 (0)