Skip to content

Trim the README and AGENTS.md, and cover skills and debugging - #105

Open
bcherry wants to merge 6 commits into
mainfrom
bcherry/stoic-meitner-0makbf
Open

bcherry wants to merge 6 commits into
mainfrom
bcherry/stoic-meitner-0makbf

Conversation

@bcherry

@bcherry bcherry commented Sep 23, 2026

Copy link
Copy Markdown
Contributor

Follow-up to #103, carrying over the review rounds on the Node starter (livekit-examples/agent-starter-node#65) so the two READMEs stay in step.

What

  • AGENTS.md
    • Drops guidance a coding agent can work out on its own: the project-layout paragraph, the run-command walkthrough, and the "following is a guide" preamble. Tooling is now two lines (uv, and ruff for formatting).
    • Adds a section on the bundled livekit-agents skill, with a fallback path for tools that don't load skills on their own, and a debugging checklist.
  • README
    • The feature list says what each piece does for you and links the docs for how. That covers Fish Audio as an expressive, cost-effective default, expressive mode, and adaptive interruption handling, which the starter enables but the list never mentioned.
    • "Using coding agents" shows lk docs search followed by lk docs get-page, since search only returns excerpts, and points to the bundled AGENTS.md and skill.
    • CLI install is a three-line list, with a link to the update instructions.
    • Manual setup includes the git clone it was missing.
    • "Run the agent" shows lk agent console and lk agent dev, then the direct uv run src/agent.py start for production. That's what the Dockerfile runs, so the old "the container doesn't include lk" caveat goes away.
    • "Testing and debugging" adds Agent Console and lk agent logs.
  • Copy pass against the docs style guide: sentence-case headings, no "we", no hyphens standing in for dashes, bulleted rather than numbered lists where order doesn't matter, and less filler. The feature list mentions the simulation suite instead of the eval suite that Replace the pytest evals with the simulation suite #99 replaced, and links point at the current testing, observability, and workflows paths.

Notes for reviewers

  • "Cost-effective" is based on LiveKit Inference pricing: Fish Audio S2.1 Pro is $15 per 1M characters, the lowest paid TTS tier, against $50 for Cartesia and $150–300 for ElevenLabs.
  • The shared "LiveKit documentation" block in AGENTS.md only got light edits (heading case, grammar), since it's likely mirrored in other starters. It keeps "prefer browsing over search" and now adds that search results are excerpts to follow up with get-page.
  • The branch's commit list includes Use lk agent for console, dev, and start #103's two commits and a no-op merge. The diff against main is only these two files, and a squash-merge keeps main clean.
  • Every docs.livekit.io link in both files returns 200 without a redirect.

🤖 Generated with Claude Code

https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv

The Python CLI's dev mode is deprecated and its in-process auto-reload has
been removed, so `lk agent dev` is now the only way to get hot reload. Point
the README, the taskfile help output, and the `dev` task at the LiveKit CLI
for all three local modes, and move the CLI install instructions into Dev
Setup so they come before the first command that needs them.

The Dockerfile still starts the deployed agent with `uv run src/agent.py
start`, since the container image doesn't include `lk`.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
Mirrors the Node starter's review round: drop guidance a coding agent can
work out on its own, show the direct `uv run src/agent.py start` for
production since that's what the Dockerfile runs, and collapse the CLI
install block into a three-line list with a link to update instructions.

Also a copy pass against the docs style guide: sentence-case headings,
no "we", no hyphens standing in for dashes, bulleted rather than numbered
non-sequential lists, and less filler throughout.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
The README feature list now says what each piece does for you and links
the docs for how: Fish Audio as an expressive, cost-effective default,
expressive mode, and adaptive interruption handling, which the starter
enables but the list never mentioned. "Using coding agents" points at the
bundled AGENTS.md and livekit-agents skill, and the testing section adds
Agent Console and `lk agent logs` for debugging.

AGENTS.md gains a section on the bundled skill (with a fallback path for
tools that do not load skills on their own) and a debugging checklist.
Links to the moved testing, observability, and workflows pages now point
at their current paths.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
@bcherry bcherry changed the title Trim the README and AGENTS.md, and apply the docs style guide Trim the README and AGENTS.md, and cover skills and debugging Sep 23, 2026
Search returns short excerpts, so reading a result means fetching the
full page. Show both commands in the README, and tell coding agents in
AGENTS.md to fetch the page before acting on a search result.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7yszNU7t5aCHJsKLmU4hv
@bcherry
bcherry requested a review from u9g September 23, 2026 20:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants