Skip to content

Add steering docs and clarify mode#37

Merged
kawax merged 1 commit intomainfrom
steering
Mar 9, 2026
Merged

Add steering docs and clarify mode#37
kawax merged 1 commit intomainfrom
steering

Conversation

@kawax
Copy link
Member

@kawax kawax commented Mar 9, 2026

This pull request introduces documentation and clarifies the behavior of message delivery modes in the Copilot agent system. The main focus is explaining the difference between "enqueue" (queueing) and "immediate" (steering) modes, and updating code comments to improve clarity for developers. The most important changes are grouped below.

Documentation improvements:

  • Added a new Japanese documentation file steering.md describing the concepts of steering and queueing, their usage patterns, and best practices for Laravel applications.

Code comment clarifications:

  • Updated PHPDoc comments in src/Contracts/Factory.php, src/CopilotManager.php, and multiple methods in src/Session.php to clarify the meaning of the $mode parameter: "enqueue" queues messages for the next turn, "immediate" injects messages into the current turn (steering), and omitting $mode is recommended for normal use. [1] [2] [3] [4] [5]

Add docs/jp/steering.md explaining steering ("immediate") vs queuing ("enqueue") with examples and best practices (Japanese). Update PHP docblocks in src/Contracts/Factory.php, src/CopilotManager.php, and src/Session.php to clarify the $mode parameter semantics (default queueing, "immediate" injects into the current turn/steering) and recommend omitting it for normal use. Documentation-only changes; no runtime behavior modified.
@kawax kawax merged commit 335cf94 into main Mar 9, 2026
5 checks passed
@kawax kawax deleted the steering branch March 9, 2026 11:37
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.

1 participant