Add LLM agent guidance files and player component architecture docs - #1
Draft
cpringle-bs with Copilot wants to merge 2 commits into
Draft
Add LLM agent guidance files and player component architecture docs#1cpringle-bs with Copilot wants to merge 2 commits into
cpringle-bs with Copilot wants to merge 2 commits into
Conversation
Agent-Logs-Url: https://github.com/cpringle-bs/streaming_tools/sessions/2ddd57e3-2209-4b03-9197-e7c510efe963 Co-authored-by: cpringle-bs <171565932+cpringle-bs@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add agents.md for new player component guidance
Add LLM agent guidance files and player component architecture docs
Mar 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No guidance exists for LLM agents working in this repo, and there is no design documentation for the planned player component. Establishes the convention and content for both.
New files
AGENTS.md— Root-level agent guidance: component inventory, architecture summary, shell script conventions, key design decisions (UDP multicast, MPEG-TS, latency-first).github/copilot-instructions.md— GitHub Copilot auto-loaded instructions; surfaces critical context (raw UDP multicast, not HLS/DASH) and cross-references the other docsdocs/architecture.md— Full system design: transport diagram, stream composition (H.264 + AC3 PIDs), timing/latency parameter table with rationaledocs/player-architecture.md— Player design spec: goals, chosen approach (FFplay wrapper shell script), alternatives considered and rejected, required FFplay flags, configurable variables, file layout, explicit out-of-scope itemsplayer/AGENTS.md— Player-scoped agent guidance: four hard constraints (no extra latency, no new deps, no signalling, variables not literals), files to create, manual test procedureConventions established
All guidance files follow a consistent pattern: each significant component directory gets an
AGENTS.mdthat states design intent, constraints, and how an agent should approach modifications — rather than leaving that context implicit.Original prompt
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.