Skip to content
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/model/orchestrator/runners/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Hot Runner Protocol

Extensible runner registration and persistent Unity editor provider protocol.

See GitHub Issue for full specification.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Replace the generic issue reference with a direct link and minimal protocol outline.

“See GitHub Issue for full specification.” is too vague in standalone docs. Please link the exact issue (e.g., #789 URL) and add a short bullet list of the protocol surface (Register, Heartbeat, job assignment, result posting) plus key inputs so this README is useful without extra lookup.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/model/orchestrator/runners/README.md` at line 5, Replace the vague "See
GitHub Issue for full specification." line in README.md with a direct link to
the exact issue (e.g., https://github.com/.../issues/789) and add a minimal
protocol outline listing the surface methods/steps: Register, Heartbeat,
JobAssignment, ResultPosting; for each include key inputs (e.g., Register:
runner_id, capabilities; Heartbeat: runner_id, status, timestamp; JobAssignment:
job_id, payload; ResultPosting: job_id, status, result). Ensure the new text is
short — one sentence linking the issue followed by a 3–5 bullet points naming
the protocol actions and their core inputs so the README is usable without
visiting the issue.

Loading