docs(webui): document slash command lifecycles

This commit is contained in:
chengyongru
2026-07-07 15:42:04 +08:00
committed by Xubin Ren
parent fa73448f6f
commit 7e135b45f3
2 changed files with 15 additions and 0 deletions
+6
View File
@@ -17,6 +17,12 @@ from nanobot.command.router import CommandContext, CommandRouter
from nanobot.utils.helpers import build_status_content
from nanobot.utils.restart import set_restart_notice_to_env
# WebUI protocol contract for how a slash command participates in turn state:
# - side_channel: returns control text without starting or ending an agent turn.
# - finalize_active_turn: side-channel command that also closes the active UI turn.
# - stop_active_turn: cancels the active turn; WebUI may intercept exact submits.
# - agent_turn: always enters the normal agent path.
# - agent_turn_with_args: no args is side-channel usage; args enter the agent path.
CommandLifecycle = Literal[
"side_channel",
"finalize_active_turn",
+9
View File
@@ -781,6 +781,15 @@ export interface TranscriptionSettingsUpdate {
maxUploadMb: number;
}
/**
* Backend-owned contract for how a slash command affects WebUI turn state.
*
* - side_channel: returns control text without starting or ending an agent turn.
* - finalize_active_turn: side-channel command that also closes the active UI turn.
* - stop_active_turn: cancels the active turn; exact submits may be intercepted locally.
* - agent_turn: always enters the normal agent path.
* - agent_turn_with_args: no args is side-channel usage; args enter the agent path.
*/
export type SlashCommandLifecycle =
| "side_channel"
| "finalize_active_turn"