Skip to content

Commit 5f2d825

Browse files
bcherryclaude
andcommitted
Port remaining URL and content updates from Node starter PR
Updates docs URLs to match new site structure: - /agents/build/ -> /agents/logic/ and /agents/start/ - /home/cloud/ -> /transport/media/ - /home/self-hosting/ -> /transport/self-hosting/local/ - /agents/ops/deployment/ -> /deploy/agents/ - Metrics/logging -> Agent Observability - Voice pipeline description updated Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent c42962c commit 5f2d825

2 files changed

Lines changed: 14 additions & 14 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Voice AI agents are highly sensitive to excessive latency. For this reason, it's
4242

4343
## Testing
4444

45-
When possible, add tests for agent behavior. Read the [documentation](https://docs.livekit.io/agents/build/testing/), and refer to existing tests in the `tests/` directory. Run tests with `uv run pytest`.
45+
When possible, add tests for agent behavior. Read the [documentation](https://docs.livekit.io/agents/start/testing/), and refer to existing tests in the `tests/` directory. Run tests with `uv run pytest`.
4646

4747
Important: When modifying core agent behavior such as instructions, tool descriptions, and tasks/workflows/handoffs, never just guess what will work. Always use test-driven development (TDD) and begin by writing tests for the desired behavior. For instance, if you're planning to add a new tool, write one or more tests for the tool's behavior, then iterate on the tool until the tests pass correctly. This will ensure you are able to produce a working, reliable agent for the user.
4848

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ A complete starter project for building voice AI apps with [LiveKit Agents for P
99
The starter project includes:
1010

1111
- A simple voice AI assistant, ready for extension and customization
12-
- A voice AI pipeline with [models](https://docs.livekit.io/agents/models) from OpenAI, Cartesia, and Deepgram served through LiveKit Cloud
13-
- Easily integrate your preferred [LLM](https://docs.livekit.io/agents/models/llm/), [STT](https://docs.livekit.io/agents/models/stt/), and [TTS](https://docs.livekit.io/agents/models/tts/) instead, or swap to a realtime model like the [OpenAI Realtime API](https://docs.livekit.io/agents/models/realtime/openai)
14-
- Eval suite based on the LiveKit Agents [testing & evaluation framework](https://docs.livekit.io/agents/build/testing/)
15-
- [LiveKit Turn Detector](https://docs.livekit.io/agents/build/turns/turn-detector/) for contextually-aware speaker detection, with multilingual support
16-
- [Background voice cancellation](https://docs.livekit.io/home/cloud/noise-cancellation/)
17-
- Integrated [metrics and logging](https://docs.livekit.io/agents/build/metrics/)
18-
- A Dockerfile ready for [production deployment](https://docs.livekit.io/agents/ops/deployment/)
12+
- A voice AI pipeline built on [LiveKit Inference](https://docs.livekit.io/agents/models/inference)
13+
with [models](https://docs.livekit.io/agents/models) from OpenAI, Cartesia, and Deepgram. More than 50 other model providers are supported, including [Realtime models](https://docs.livekit.io/agents/models/realtime)
14+
- Eval suite based on the LiveKit Agents [testing & evaluation framework](https://docs.livekit.io/agents/start/testing/)
15+
- [LiveKit Turn Detector](https://docs.livekit.io/agents/logic/turns/turn-detector/) for contextually-aware speaker detection, with multilingual support
16+
- [Background voice cancellation](https://docs.livekit.io/transport/media/noise-cancellation/)
17+
- Deep session insights from LiveKit [Agent Observability](https://docs.livekit.io/deploy/observability/)
18+
- A Dockerfile ready for [production deployment to LiveKit Cloud](https://docs.livekit.io/deploy/agents/)
1919

20-
This starter app is compatible with any [custom web/mobile frontend](https://docs.livekit.io/frontends/) or [SIP-based telephony](https://docs.livekit.io/telephony/).
20+
This starter app is compatible with any [custom web/mobile frontend](https://docs.livekit.io/frontends/) or [telephony](https://docs.livekit.io/telephony/).
2121

2222
## Using coding agents
2323

@@ -81,7 +81,7 @@ Sign up for [LiveKit Cloud](https://cloud.livekit.io/) then set up the environme
8181
- `LIVEKIT_API_KEY`
8282
- `LIVEKIT_API_SECRET`
8383

84-
You can load the LiveKit environment automatically using the [LiveKit CLI](https://docs.livekit.io/intro/basics/cli/start/):
84+
You can load the LiveKit environment automatically using the [LiveKit CLI](https://docs.livekit.io/intro/basics/cli/):
8585

8686
```bash
8787
lk cloud auth
@@ -92,7 +92,7 @@ lk app env -w -d .env.local
9292

9393
## Run the agent
9494

95-
Before your first run, you must download certain models such as [Silero VAD](https://docs.livekit.io/agents/build/turns/vad/) and the [LiveKit turn detector](https://docs.livekit.io/agents/build/turns/turn-detector/):
95+
Before your first run, you must download certain models such as [Silero VAD](https://docs.livekit.io/agents/logic/turns/vad/) and the [LiveKit turn detector](https://docs.livekit.io/agents/logic/turns/turn-detector/):
9696

9797
```console
9898
uv run python src/agent.py download-files
@@ -134,7 +134,7 @@ For advanced customization, see the [complete frontend guide](https://docs.livek
134134

135135
## Tests and evals
136136

137-
This project includes a complete suite of evals, based on the LiveKit Agents [testing & evaluation framework](https://docs.livekit.io/agents/build/testing/). To run them, use `pytest`.
137+
This project includes a complete suite of evals, based on the LiveKit Agents [testing & evaluation framework](https://docs.livekit.io/agents/start/testing/). To run them, use `pytest`.
138138

139139
```console
140140
uv run pytest
@@ -152,11 +152,11 @@ Once you've started your own project based on this repo, you should:
152152

153153
## Deploying to production
154154

155-
This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/agents/ops/deployment/) guide.
155+
This project is production-ready and includes a working `Dockerfile`. To deploy it to LiveKit Cloud or another environment, see the [deploying to production](https://docs.livekit.io/deploy/agents/) guide.
156156

157157
## Self-hosted LiveKit
158158

159-
You can also self-host LiveKit instead of using LiveKit Cloud. See the [self-hosting](https://docs.livekit.io/home/self-hosting/) guide for more information. If you choose to self-host, you'll need to also use [model plugins](https://docs.livekit.io/agents/models/#plugins) instead of LiveKit Inference and will need to remove the [LiveKit Cloud noise cancellation](https://docs.livekit.io/home/cloud/noise-cancellation/) plugin.
159+
You can also self-host LiveKit instead of using LiveKit Cloud. See the [self-hosting](https://docs.livekit.io/transport/self-hosting/local/) guide for more information. If you choose to self-host, you'll need to also use [model plugins](https://docs.livekit.io/agents/models/#plugins) instead of LiveKit Inference and will need to remove the [LiveKit Cloud noise cancellation](https://docs.livekit.io/transport/media/noise-cancellation/) plugin.
160160

161161
## License
162162

0 commit comments

Comments
 (0)