Skip to content

Commit 14fb56c

Browse files
rachaelrenkoz-agent
authored andcommitted
docs: restore 175 image figcaptions from GitBook migration (#37)
* docs: restore image figcaptions from GitBook migration Add <figure>+<figcaption> wrappers to 175 images across 68 MDX files, restoring the visible captions that were lost during the GitBook → Astro Starlight migration. Captions extracted from the GitBook source and matched by image filename. Also adds: - CSS styling for figure and figcaption elements (centered, sm text, gray-3 color) in custom.css - Migration scripts (migrate-figcaptions.py for analysis, apply-figcaptions.py for automated application) Empty figcaptions (145 instances) are intentionally skipped — they had no visible text in GitBook either. Co-Authored-By: Oz <oz-agent@warp.dev> * chore: remove one-time figcaption migration scripts These were used to generate the content changes in this PR and don't need to live in the repo. Co-Authored-By: Oz <oz-agent@warp.dev> * docs: add image caption guidelines to style guide and CSS Add an 'Image caption guidelines' section to AGENTS.md with rules for writing good figcaptions: orient don't instruct, keep short, no marketing language, don't repeat prose, don't list everything. Includes positive and negative examples. Also adds a brief editorial note in custom.css next to the figcaption styles pointing to the AGENTS.md guidelines. Co-Authored-By: Oz <oz-agent@warp.dev> * docs: rewrite figcaptions to follow image caption guidelines Apply the caption guidelines from AGENTS.md to all 174 figcaptions: - Remove procedural instructions from captions (belongs in body text) - Remove marketing language ('easily,' 'at a glance,' etc.) - Shorten exhaustive lists to concise subject descriptions - Trim verbose captions to ~10 words - Add missing trailing periods for consistency - Fix 'Oz Web App' casing to 'Oz web app' per terminology 140 captions rewritten across 58 files. Co-Authored-By: Oz <oz-agent@warp.dev> * docs: rewrite fragment captions as complete sentences Rewrite 28 cryptic fragment captions (e.g. 'Derived from rules.', 'Alt-screen padding setting.') as complete sentences that orient the reader without requiring them to look at the image. Also adds 'Write complete sentences' as an explicit rule in the AGENTS.md image caption guidelines. Co-Authored-By: Oz <oz-agent@warp.dev> --------- Co-authored-by: Oz <oz-agent@warp.dev>
1 parent 9585674 commit 14fb56c

70 files changed

Lines changed: 567 additions & 0 deletions

File tree

Some content is hidden

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

AGENTS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,26 @@ Use formatting consistently to distinguish different types of content:
177177
- File naming: lowercase, hyphens, descriptive (`agent-mode-code-diff.png`, not `Screenshot 2026-03-15.png`)
178178
- Store PNGs in `src/assets/<section>/` (Astro optimizes them) and GIFs in `public/assets/<section>/` (to bypass optimization). See the "Assets" section below for the full convention.
179179

180+
#### Image caption guidelines
181+
Captions orient the reader — they identify what the image shows so the reader knows where to look. They are not a place for instructions, marketing language, or exhaustive descriptions.
182+
183+
**Rules:**
184+
- **Orient, don't instruct** — describe what is shown, not what to do. Procedural steps belong in the body text.
185+
- **Write complete sentences** — every caption should read as a standalone sentence, not a fragment or label. A reader should understand what the image shows without looking at it.
186+
- **Keep it short** — aim for 10 words or fewer. Never exceed ~20 words.
187+
- **No marketing language** — avoid "easily," "quickly," "powerful," "at a glance," or similar.
188+
- **Don't repeat the prose** — if the paragraph above already describes the image, the caption should add context, not echo it.
189+
- **Don't list everything visible** — name the subject, not every detail in the screenshot.
190+
- **Sentence case, end with a period** — consistent with all other text in the docs.
191+
192+
**Examples:**
193+
-`<figcaption>The Environments page in the Oz web app.</figcaption>`
194+
-`<figcaption>Agent Profile settings.</figcaption>`
195+
-`<figcaption>Codebase indexing settings.</figcaption>`
196+
-`<figcaption>Codebase indexing settings in Warp. Easily track sync status and manage which folders are indexed for AI-powered context and suggestions.</figcaption>` (marketing language, too long)
197+
-`<figcaption>Click the toast to jump to the agent's session.</figcaption>` (procedural — belongs in body text)
198+
-`<figcaption>Universal Input's contextual input chips, from left to right: conversation management, node version, active directory, Git and code diffs, and 2 attached images.</figcaption>` (exhaustive list)
199+
180200
### Links and cross-references
181201
- Use descriptive link text that explains what users will find
182202
- ✅ "Learn more about [Codebase Context](...)" / "See [configuring environments](...)"

src/content/docs/agent-platform/capabilities/agent-notifications.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,19 @@ Floating toast notifications appear in the corner of the Warp window when an age
2525

2626
Up to two toasts are visible at a time. If additional notifications arrive, the oldest toast is replaced.
2727

28+
<figure>
2829
![A Warp toast notification in the upper-right corner showing an agent task completed, with an Open conversation action and a keyboard shortcut chip](../../../../assets/agent-platform/toast-notification.png)
30+
<figcaption>Agent task completion notification.</figcaption>
31+
</figure>
2932

3033
### Notification mailbox
3134

3235
The notification mailbox is a sidebar panel that collects all agent notifications in one place. Open it from the bell icon in the top-right corner of Warp.
3336

37+
<figure>
3438
![The Warp notification mailbox open in the upper-right of the window with All tabs and Unread filter tabs, a Mark all as read action, and a notification entry](../../../../assets/agent-platform/notification-mailbox.png)
39+
<figcaption>Agent notification mailbox.</figcaption>
40+
</figure>
3541

3642
The mailbox includes:
3743

@@ -83,7 +89,10 @@ For **third-party CLI agents**, each agent requires a one-time setup. The proces
8389
* **Codex** - add `notification_condition = "always"` under `[tui]` in `~/.codex/config.toml`, then restart Codex. See [Codex setup](/agent-platform/cli-agents/codex/#setting-up-notifications).
8490
* **OpenCode** - add `"@warp-dot-dev/opencode-warp"` to the `plugin` array in your OpenCode config. See [OpenCode setup](/agent-platform/cli-agents/opencode/#setting-up-notifications).
8591

92+
<figure>
8693
![The Enable Claude Code notifications chip in the agent utility bar with a tooltip reading Install the Warp plugin to enable rich agent notifications within Warp](../../../../assets/agent-platform/enable-cli-agent-notifications.png)
94+
<figcaption>Notification plugin install chip.</figcaption>
95+
</figure>
8796

8897
If auto-install doesn't work or you're running an agent over SSH, Warp displays an installation-instructions chip in the terminal with setup steps you can follow directly.
8998

src/content/docs/agent-platform/capabilities/agent-profiles-permissions.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,21 @@ Agent Profiles let you configure how your Agent behaves in different situations.
1313
* **Default profile**: Every user starts with a default profile, you can edit it at any time, and new profiles will copy its settings as a starting point.
1414
* **Other profiles**: Set up different profiles for different workflows (e.g., "Safe & cautious", "YOLO mode", etc.). Manage them in the Profiles settings menu.
1515

16+
<figure>
1617
![Agent Profiles in Settings: define how your Agent operates.](../../../../assets/agent-platform/agent-profiles.png)
18+
<figcaption>Agent Profile settings.</figcaption>
19+
</figure>
1720

1821
**In each Agent Profile, you can configure:**
1922

2023
* The name of the profile
2124
* **Base model**: The core engine for your Agent. It handles most interactions and invokes other models when needed (e.g. for code generation). This model is also used for [Planning](/agent-platform/capabilities/planning/) by default, though you can configure a separate planning model.
2225
* Agent autonomy and permissions
2326

27+
<figure>
2428
![Agent Profiles in Settings: editing a Profile.](../../../../assets/agent-platform/agent-profiles-settings.png)
29+
<figcaption>Editing an Agent Profile.</figcaption>
30+
</figure>
2531

2632
## Agent Permissions
2733

@@ -63,7 +69,10 @@ The Agent lets you define an allowlist of commands that run automatically withou
6369

6470
You can add your own regular expressions to this list in **Settings** > **Agents** > **Profiles** > **Command allowlist**. Commands in the allowlist will always auto-execute, even if they are not read-only operations.
6571

72+
<figure>
6673
![Command allowlist and denylists as part of an Agent Profile.](../../../../assets/agent-platform/agent-profiles-allow-and-denylists.png)
74+
<figcaption>Command allowlist and denylists as part of an Agent Profile.</figcaption>
75+
</figure>
6776

6877
### Command denylist
6978

@@ -86,7 +95,10 @@ In this settings menu, you can configure which MCP servers the Agent is allowed
8695
* Use the MCP denylist to require approval before calling certain servers, even if they’re also in the allowlist.
8796
* Or set the Agent to “decide” — it will act autonomously when confident, and ask for confirmation when uncertain.
8897

98+
<figure>
8999
![Customize how the Agent interacts with MCP servers by choosing between “Agent decides,” allowlist, or denylist settings.](../../../../assets/agent-platform/MCP_servers_agent_permissions.png)
100+
<figcaption>MCP server interaction settings in an Agent Profile.</figcaption>
101+
</figure>
90102

91103
:::note
92104
To learn how to build and configure your own MCP server, check out the [MCP feature docs](/agent-platform/capabilities/mcp/).
@@ -108,7 +120,10 @@ During an Agent interaction, you can give the Agent full autonomy for the curren
108120
</TabItem>
109121
</Tabs>
110122

123+
<figure>
111124
![A button overlay in the lower-right corner lets you enable auto-approve or end the Agent interaction.](../../../../assets/agent-platform/run-until-completion.png)
125+
<figcaption>Auto-approve and take-over controls.</figcaption>
126+
</figure>
112127

113128
:::note
114129
_Run until completion_ ignores the denylist entirely. It's the purest form of “YOLO” mode and essentially a fully "autonomous mode" where the Agent proceeds without asking for confirmation.

src/content/docs/agent-platform/capabilities/codebase-context.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,10 @@ Feature requests:
4747
* WSL: [GitHub #6744](https://github.com/warpdotdev/Warp/issues/6744)
4848
:::
4949

50+
<figure>
5051
![Codebase indexing settings in Warp. Easily track sync status and manage which folders are indexed for AI-powered context and suggestions.](../../../../assets/agent-platform/codebase-context-main.png)
52+
<figcaption>Codebase indexing settings.</figcaption>
53+
</figure>
5154

5255
**Codebase indexing intervals and triggers:**
5356

@@ -79,7 +82,10 @@ When viewing indexed codebases in Warp under **Settings** > **Code** > **Indexin
7982
* **Failed** – Indexing failed. Common reasons include unreadable `.git` directories or corrupted repositories. Try re-cloning the repo and syncing again.
8083
* **Codebase too large** – The number of files in the codebase exceeds your current plan’s limit. You can either reduce the number of files being indexed using `.warpindexingignore`, or [contact sales](https://warp.dev/contact-sales) for support with larger codebases.
8184

85+
<figure>
8286
![View and manage the indexing status of your codebases in Warp. Easily see which projects are synced, in progress, or require attention.](../../../../assets/agent-platform/codebase-context-statuses.png)
87+
<figcaption>Codebase indexing status overview.</figcaption>
88+
</figure>
8389

8490
### When does codebase syncing happen?
8591

src/content/docs/agent-platform/capabilities/full-terminal-use.mdx

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,26 @@ You can either ask the agent to run an interactive command, or start one manuall
3333
* Example:
3434
* If you’ve already launched an interactive tool (for example `psql` or `npm run dev`), you can bring the agent into the running session using the "Use Agent" button in the terminal footer or via `CMD + I` .
3535

36+
<figure>
3637
![Option to tag the agent into a running command.](../../../../assets/agent-platform/full-terminal-use-tag-hint.png)
38+
<figcaption>Option to tag the agent into a running command.</figcaption>
39+
</figure>
3740
* Once the agent is tagged in, you can follow up with natural-language requests such as:
3841

3942
“Watch this process and help debug the error on the /session endpoint.”
4043
* Warp then attaches the agent to the active PTY so it can see the current terminal buffer and propose actions inside the session.
4144

4245
<VideoEmbed url="https://www.loom.com/share/bcedc521071a4b6a9bbcf74b5156f903" title="Tagging in the agent." />
4346

47+
<figure>
4448
![Running a build command.](../../../../assets/agent-platform/full-terminal-use-build.png)
49+
<figcaption>Running a build command.</figcaption>
50+
</figure>
4551

52+
<figure>
4653
![Tagging in the Agent to monitor the dev server.](../../../../assets/agent-platform/full-terminal-use-dev-monitor.png)
54+
<figcaption>Tagging in the Agent to monitor the dev server.</figcaption>
55+
</figure>
4756

4857
Warp attaches the agent to the running command so it can see and control the terminal buffer.
4958

@@ -68,14 +77,20 @@ You can swap control at any time.
6877
* Use the Takeover control to stop the agent from typing or performing any actions.
6978
* The shell stays open, and you can type directly into the same session.
7079

80+
<figure>
7181
![Option to take over from agent in the footer.](../../../../assets/agent-platform/full-terminal-use-takeover.png)
82+
<figcaption>Option to take over from agent in the footer.</figcaption>
83+
</figure>
7284

7385
**Hand back control**
7486

7587
* When you’re ready for the agent to continue, click the control again.
7688
* The agent resumes where you left off, with full access to the current terminal state.
7789

90+
<figure>
7891
![Option to hand-off to the agent in the conversation footer.](../../../../assets/agent-platform/full-terminal-use-handoff.png)
92+
<figcaption>Option to hand-off to the agent in the conversation footer.</figcaption>
93+
</figure>
7994

8095
This makes it easy to:
8196

@@ -140,7 +155,10 @@ Each time the agent wants to take an action inside an interactive shell, you’l
140155
* Refine the request with `CTRL + C`, which clears the proposed action and lets you follow up with a different query.
141156
* Take over manually with `CMD + I`, which stops the agent from issuing any further PTY writes until you hand control back.
142157

158+
<figure>
143159
![Allow, Refine, or Take over an agent response.](../../../../assets/agent-platform/allow-refine-takeover.png)
160+
<figcaption>Allow, Refine, or Take over an agent response.</figcaption>
161+
</figure>
144162

145163
![Ability to accept or auto-approve future interactions.](../../../../assets/agent-platform/full-terminal-use-options-2.png)
146164

src/content/docs/agent-platform/capabilities/mcp.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,10 @@ You can navigate to the MCP servers page in any of the following ways:
2626

2727
This will show a list of all configured MCP servers, including which are currently running. If you close Warp with an MCP server running, it will run again on next start of Warp. MCP servers that are stopped will remain so on next launch of Warp.
2828

29+
<figure>
2930
![MCP servers page](../../../../assets/agent-platform/mcp-servers-list.png)
31+
<figcaption>MCP servers page.</figcaption>
32+
</figure>
3033

3134
### Adding an MCP Server
3235

@@ -38,7 +41,10 @@ MCP server types you can add:
3841
<TabItem label="CLI Server (Command)">
3942
Provide a startup command. Warp will launch this command when starting up and shut it down on exit.
4043

44+
<figure>
4145
![Adding a CLI MCP Server (Command)](../../../../assets/agent-platform/mcp-servers-add-cli.png)
46+
<figcaption>Adding a CLI MCP Server (Command).</figcaption>
47+
</figure>
4248

4349
:::note
4450
Always set `working_directory` explicitly when your MCP server command or args include relative paths. This ensures consistent and predictable behavior across machines and sessions.
@@ -56,7 +62,10 @@ MCP server types you can add:
5662
<TabItem label="Streamable HTTP or SSE Server (URL)">
5763
Provide a URL where Warp can reach an already-running MCP server that supports Server-Sent Events.
5864

65+
<figure>
5966
![Adding an SSE MCP Server (URL)](../../../../assets/agent-platform/mcp-servers-add-sse.png)
67+
<figcaption>Adding an SSE MCP Server (URL).</figcaption>
68+
</figure>
6069

6170
**Streamable HTTP or SSE Server (URL) MCP Configuration Properties**
6271

@@ -161,7 +170,10 @@ You can rename and edit a server's name, as well as delete the server. If you ar
161170

162171
MCP servers can be shared with your teammates by clicking the share icon. When sharing, sensitive values in the `env` configuration will be automatically scrubbed and replaced with variables.
163172

173+
<figure>
164174
![Sharing a MCP Server](../../../../assets/agent-platform/mcp-servers-share.png)
175+
<figcaption>Sharing a MCP Server.</figcaption>
176+
</figure>
165177

166178
Your teammates can find shared MCP servers under the `Shared` section of their MCP settings. When your teammates install your server configuration, they will be prompted to enter any scrubbed `env` values.
167179

src/content/docs/agent-platform/capabilities/model-choice.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,10 @@ Warp also supports leading open source models hosted via Fireworks AI, so you ca
9191

9292
You can use the model picker in your prompt input to quickly switch between models. The currently active model appears directly in the input editor.
9393

94+
<figure>
9495
![Model selector dropdown showing available models with Intelligence, Speed, and Cost benchmarks](../../../../assets/agent-platform/model-selector-dropdown.png)
96+
<figcaption>Model selector in Warp's input.</figcaption>
97+
</figure>
9598

9699
To change models, click the displayed model name (for example, _Claude Sonnet 4.5_) to open a dropdown with all supported options. Your selection will automatically persist for future prompts.
97100

src/content/docs/agent-platform/capabilities/planning.mdx

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,53 +18,80 @@ Warp has native planning functionality that helps you break down complex enginee
1818

1919
You can generate a plan using the `/plan` [slash command](/agent-platform/capabilities/slash-commands/) or by asking the agent in natural language.
2020

21+
<figure>
2122
![Prompting the agent to create a plan using the slash command.](../../../../assets/agent-platform/plan-slash-command.png)
23+
<figcaption>Creating a plan with the /plan command.</figcaption>
24+
</figure>
2225

2326
The agent then creates a structured plan inside Warp’s native rich text editor, which is designed for long, multi-step workflows. The editor includes clean formatting, inline code blocks, and clickable file paths so you can open referenced files immediately in Warp (see below) or in your external editor.
2427

2528
### Reviewing and editing
2629

2730
Once a plan is generated, you can review it, reorganize steps, or refine details. You can edit the document manually or ask the agent to revise sections for you.
2831

32+
<figure>
2933
![Plan editor in Warp.](../../../../assets/agent-platform/planning-main-view.png)
34+
<figcaption>Plan editor in Warp.</figcaption>
35+
</figure>
3036

3137
Any update made by the agent **creates a new version**. Version history lets you compare past iterations and restore an older version if you want to revert your approach, preserving a clear decision trail as the plan evolves.
3238

39+
<figure>
3340
![Access previous versions of your plan.](../../../../assets/agent-platform/agent-plans-versioning.png)
41+
<figcaption>Access previous versions of your plan.</figcaption>
42+
</figure>
3443

3544
### Executing a plan
3645

3746
When you’re ready to start implementing, prompt the agent to run the plan. You can ask it to execute the full set of steps or only a specific section, such as “Implement phase 1 of the plan.”
3847

48+
<figure>
3949
![Manually referencing the plan using @ to kickoff the plan.](../../../../assets/agent-platform/manually-trigger-plan.png)
50+
<figcaption>Referencing a plan using @.</figcaption>
51+
</figure>
4052

4153
The agent applies changes incrementally and updates files as it proceeds. This makes it easy to validate early steps before moving forward, adjust the plan mid-run, or try alternative paths without committing to the full workflow.
4254

4355
If you revise the plan while the agent is running, you can notify it directly; the agent will adjust its execution based on your updates.
4456

57+
<figure>
4558
![Option to pass new plan to agent if plan changes during runtime.](../../../../assets/agent-platform/update-agent-mid-plan.png)
59+
<figcaption>Prompt to update the agent's plan during execution.</figcaption>
60+
</figure>
4661

4762
### Monitoring progress
4863

4964
While the agent is running, you can reopen the plan at any time by selecting **View plan** in the input. You can also follow each change in real time through the [Code Review](/code/code-review/) panel and add comments or guidance using [Interactive Code Review](/agent-platform/local-agents/interactive-code-review/).
5065

66+
<figure>
5167
![Monitoring progress with the task list and plan view.](../../../../assets/agent-platform/agent-plans-tasks.png)
68+
<figcaption>Monitoring progress with the task list and plan view.</figcaption>
69+
</figure>
5270

5371
This gives you clear oversight, helps confirm expected behavior, and lets you intervene quickly if something needs correction.
5472

5573
### Saving and sharing
5674

5775
Warp automatically saves all plans in the _Plans_ folder in [Warp Drive](/knowledge-and-collaboration/warp-drive/). You'll see a confirmation when your plan is synced.
5876

77+
<figure>
5978
![Plans are automatically synced to Warp Drive.](../../../../assets/agent-platform/agent-plans-synced.png)
79+
<figcaption>Plans are automatically synced to Warp Drive.</figcaption>
80+
</figure>
6081

6182
You can export any plan as Markdown, check it into your repository, or share a link—useful for GitHub PRs, design reviews, or async collaboration.
6283

84+
<figure>
6385
![Different ways to share a plan.](../../../../assets/agent-platform/export-notebooks.png)
86+
<figcaption>Different ways to share a plan.</figcaption>
87+
</figure>
6488

6589
Because plans persist in Warp Drive, you can return to them later, reuse them for new work, or treat them as documentation for ongoing projects. This is also naturally passed to the agent as context.
6690

91+
<figure>
6792
![Plans are accessible directly from the Warp Drive side panel.](../../../../assets/agent-platform/plans-in-warp-drive-side-panel.png)
93+
<figcaption>Plans are accessible directly from the Warp Drive side panel.</figcaption>
94+
</figure>
6895

6996
You can configure whether your plans will be automatically added and synced to Warp Drive in your [Agent Profiles & Permissions](/agent-platform/capabilities/agent-profiles-permissions/) under **Settings** > **Agents** > **Profiles**.
7097

0 commit comments

Comments
 (0)