chore: update README and env vars to clarify agent name and agent dispatch responsibilities #312
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
Problem
README and comments state
agentNameis for LiveKit Cloud Sandbox, which is misleading because it's also necessary if you're testing with an agent that requires explicit dispatch. Agent's exported form Agent Builder default to explicit dispatchTesting an agent using explicit dispatch requires you modify
agentNameinapp-config.tsfile which causes a git diff. This git diff could be accidentally checked in.Solution
Update README and comments to indicate
agentNameis part of agent dispatch configuration.By implementing
AGENT_NAMEin.env.localthis value will not impact git diff's or cause it to be accidentally checked in.Key changes:
.env.example: AddedAGENT_NAMEenvironment variable with documentation explaining automatic vs explicit dispatch modesREADME.md: Updated documentation to reflect the new configuration structure and environment variableapp-config.ts:agentNamefrom local env vars, default to undefined