Skip to content

Commit 4536ede

Browse files
authored
docs: drop release-candidate framing ahead of the 4.5 GA (#4100)
Removes the release-candidate framing from the docs for the 4.5 GA: the `@rc` install caveats on the `skills` CLI command, and the AI Agents and Prompts release-candidate banner (a shared snippet used across the ai-chat and prompts pages) plus the `>=4.5.0-rc.0` compatibility pin in the AI reference.
1 parent 9e14c6f commit 4536ede

43 files changed

Lines changed: 4 additions & 180 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/ai-chat/actions.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Actions"
44
description: "Custom commands sent from the frontend that mutate chat state without consuming a turn — undo, rollback, edit, regenerate."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
## Overview
128

139
Custom actions let the frontend send structured commands (undo, rollback, edit, regenerate) that modify the conversation state. **Actions are not turns**: they fire `hydrateMessages` (if set) and `onAction` only. No turn lifecycle hooks (`onTurnStart` / `prepareMessages` / `onBeforeTurnComplete` / `onTurnComplete`), no `run()`, no turn-counter increment. The trace span is named `chat action`.

docs/ai-chat/anatomy.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Anatomy"
44
description: "The moving parts of a chat agent — the agent task, the session, the frontend transport — and which page covers each."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
**A chat agent is three parts: a long-lived agent task that runs the turn loop, a durable Session carrying messages in and the response stream out, and a frontend transport that plugs the session into `useChat`.** The pages in this section each own one part of that picture. This page is the map — if you'd rather read mechanics end to end, skip to [How it works](/ai-chat/how-it-works).
128

139
```mermaid

docs/ai-chat/backend.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Backend"
44
description: "Three approaches to building your chat backend — chat.agent(), session iterator, or raw task primitives."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
There are three abstraction levels for a chat backend. All three speak the same wire protocol, so the [frontend transport](/ai-chat/frontend) works unchanged whichever you pick.
128

139
| Capability | `chat.agent()` | `chat.createSession()` | Raw primitives |

docs/ai-chat/background-injection.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Background injection"
44
description: "Inject context from background work into the agent's conversation — self-review, RAG augmentation, or any async analysis."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
## Overview
128

139
`chat.inject()` queues model messages for injection into the conversation. Messages are picked up at the start of the next turn or at the next `prepareStep` boundary (between tool-call steps).

docs/ai-chat/chat-local.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "chat.local"
44
description: "Typed, run-scoped data accessible from hooks, run(), tools, and subtasks. Survives across turns, auto-cleared between runs, auto-hydrated into subtasks."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
Use `chat.local` to create typed, run-scoped data that persists across turns and is accessible from anywhere — the run function, tools, nested helpers. Each run gets its own isolated copy, and locals are automatically cleared between runs.
128

139
Lifecycle hooks and **`run`** also receive **`ctx`** ([`TaskRunContext`](/ai-chat/reference#task-context-ctx)) — the same object as on a standard `task()` — for tags, metadata, and cleanup that needs the full run record.

docs/ai-chat/client-protocol.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Client Protocol"
44
description: "The wire protocol for building custom chat transports — how clients communicate with chat agents over Sessions and SSE."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
This page documents the protocol that chat clients use to communicate with `chat.agent()` tasks. Use this if you're building a custom transport (e.g., for a Slack bot, CLI tool, or native app) instead of using the built-in `TriggerChatTransport` or `AgentChat`.
128

139
<Note>

docs/ai-chat/compaction.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Compaction"
44
description: "Automatic context compaction to keep long conversations within token limits."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
## Overview
128

139
Long conversations accumulate tokens across turns. Eventually the context window fills up, causing errors or degraded responses. Compaction solves this by automatically summarizing the conversation when token usage exceeds a threshold, then using that summary as the context for future turns.

docs/ai-chat/custom-agents.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Custom agents"
44
description: "Build chat agents without chat.agent()'s managed lifecycle: register with chat.customAgent(), then drive turns with the createSession iterator or a hand-rolled loop."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
**A custom agent is a task you register with `chat.customAgent()` and drive yourself — either with the managed turn iterator from `chat.createSession()`, or with a fully hand-rolled loop over the raw chat primitives.** You give up `chat.agent()`'s lifecycle hooks and automatic continuation recovery; you gain inline control over every turn, and (at the lowest level) full control over the stream conversion.
128

139
See the [comparison table](/ai-chat/backend) before dropping down. The frontend is unchanged either way: all levels speak the same wire protocol, so [`useTriggerChatTransport`](/ai-chat/frontend) points at a custom agent exactly like a `chat.agent()`.

docs/ai-chat/error-handling.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Error handling"
44
description: "How errors flow through chat.agent — stream errors, hook errors, run failures — and how to recover."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
`chat.agent` errors fall into four layers, each with different recovery semantics. The default behavior is **conversation-preserving**: a thrown error in a hook or `run()` does not kill the chat. The current turn ends with an error chunk, and the agent waits for the user's next message.
128

139
## Error layers at a glance

docs/ai-chat/fast-starts.mdx

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,6 @@ sidebarTitle: "Fast starts"
44
description: "Two ways to cut first-turn TTFC: Preload eagerly triggers the run before the first message; Head Start runs step 1 in your warm server while the agent boots in parallel."
55
---
66

7-
import RcBanner from "/snippets/ai-chat-rc-banner.mdx";
8-
9-
<RcBanner />
10-
117
The first turn of a brand-new conversation pays for the chat.agent run's cold start: dequeue, process boot, `onPreload` / `onChatStart` hooks, and only then the LLM call. Two features address this from different angles.
128

139
## Picking an approach

0 commit comments

Comments
 (0)