Skip to content

docs: expand AGENTS.md contributor map#5578

Open
shizhigu wants to merge 2 commits intolivekit:mainfrom
shizhigu:codex/agents-contributor-map
Open

docs: expand AGENTS.md contributor map#5578
shizhigu wants to merge 2 commits intolivekit:mainfrom
shizhigu:codex/agents-contributor-map

Conversation

@shizhigu
Copy link
Copy Markdown

@shizhigu shizhigu commented Apr 28, 2026

Summary

  • Expand AGENTS.md into a practical map of the repository for contributors and coding agents.
  • Document core package areas, runtime flow, local commands, plugin layout, testing guidance, and code style expectations.
  • Add notes about voice subpackages and older Worker naming so contributors can map old issues/docs to the current AgentServer entrypoint.
  • Call out when to consult the LiveKit server repository for dispatch/protocol behavior.

Verification

  • Spot-checked the documented paths and commands against the current tree: livekit-agents, livekit-plugins, examples, root Makefile, and tests/Makefile.
  • Verified the docker-backed provider command is scoped to TTS with PLUGIN=openai.
  • git diff --check

Notes

  • Documentation-only change. No package manifests or changelog changes.

@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 28, 2026

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@shizhigu shizhigu changed the title Expand AGENTS.md contributor map docs: expand AGENTS.md contributor map Apr 28, 2026
@shizhigu shizhigu force-pushed the codex/agents-contributor-map branch from 9d7570d to de00657 Compare April 29, 2026 20:50
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