You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .agents/references/terminology.md
+13-2Lines changed: 13 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,6 +93,15 @@ For the summary of the most critical terms (core features, Oz terms, terms to av
93
93
94
94
-**Slash Commands** — Built-in commands you run by typing `/` to trigger actions (or run saved prompts).
95
95
96
+
-**Agent Memory** — Oz's persistent, cross-harness memory layer that lets agents read and write durable knowledge across conversations, harnesses, and devices. Currently in research preview.
97
+
*Usage note:* Capitalize as a feature name. Lowercase "memory" only when describing the generic concept (e.g., "the memory layer").
98
+
99
+
-**memory store** — A named collection of memories owned by a user (personal) or team. Multiple agents can share a store, and per-agent attachments control read/write access.
100
+
*Usage note:* Lowercase common noun. Capitalize the first letter only at the start of a sentence or bullet.
101
+
102
+
-**Handoff** — The feature for moving an agent's work between a local Warp session and the cloud, or continuing a finished cloud run. Supports local-to-cloud, cloud-to-cloud, and cloud-to-local directions.
103
+
*Usage note:* Capitalize as a feature name. Use lowercase "hand off" / "handed off" only as a verb.
@@ -236,9 +245,11 @@ For the summary of the most critical terms (core features, Oz terms, terms to av
236
245
## Billing and credits
237
246
238
247
-**Add-on Credits** — capitalized as a product feature name
239
-
-**Cloud Agent Credits** — capitalized as a billing feature name
248
+
-**compute credits** — lowercase common noun; capitalize the first letter only at the start of a sentence or bullet. The compute bucket, consumed when an agent run uses Warp-hosted compute. Use alongside AI credits and platform credits when describing credit types.
249
+
-**cloud agent credits** — lowercase common noun; capitalize the first letter only at the start of a sentence or bullet. Credits consumed by cloud agents, in contrast with local agent credits. Refers to the same compute bucket as compute credits; choose the term that fits the framing.
250
+
-**platform credits** — lowercase common noun; capitalize the first letter only at the start of a sentence or bullet. The platform-infrastructure bucket, consumed for every cloud agent run plus local runs with customer-supplied inference.
240
251
-**credits** — the unit of usage for AI features in Warp (lowercase, not "AI credits")
241
-
-**plan credits** — credits included with a subscription plan
252
+
-**Warp credits** — credits included with a subscription plan. Use in user-facing copy rather than "plan credits."
# Terminology: wrong → right (case-sensitive checks)
45
46
PRODUCT_CASING= {
46
47
"Warp Terminal": ("Warp", "Use 'Warp' unless specifically distinguishing from Oz"),
48
+
"Cloud Agent Credits": ("cloud agent credits", "Use lowercase 'cloud agent credits' (host-context) or 'compute credits' (bucket-context); capitalize first letter only at start of a sentence/bullet"),
49
+
"Platform Credits": ("platform credits", "Use lowercase 'platform credits'; capitalize first letter only at start of a sentence/bullet/heading"),
47
50
"agent mode": ("Agent Mode", "Capitalize as a feature name"),
48
51
"agent management panel": ("Agent Management Panel", "Capitalize as a UI surface name"),
49
52
"warp drive": ("Warp Drive", "Capitalize as a feature name"),
Copy file name to clipboardExpand all lines: AGENTS.md
+35-2Lines changed: 35 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -177,6 +177,35 @@ Use formatting consistently to distinguish different types of content:
177
177
- File naming: lowercase, hyphens, descriptive (`agent-mode-code-diff.png`, not `Screenshot 2026-03-15.png`)
178
178
- 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.
179
179
180
+
#### Screenshot placement guidelines
181
+
Use screenshots to clarify product surfaces, configuration points, or visual states that are hard to understand from prose alone. Don't add screenshots for every step in a straightforward procedure.
182
+
183
+
**Good screenshot placements:**
184
+
-**After the concept or behavior is introduced** — Place the screenshot immediately after the paragraph that explains the UI or state it shows.
185
+
-**Near configuration instructions** — Show settings panels, side panes, or menus where users make choices.
186
+
-**Near status or result explanations** — Show outputs, references, badges, progress indicators, or completion states that help users recognize success.
187
+
-**At the start of visual feature pages** — Use a broad orientation screenshot early when the page explains a new surface or layout.
188
+
189
+
**Avoid:**
190
+
- Repeating the same surface in multiple screenshots unless each image shows a meaningfully different state.
191
+
- Screenshots that duplicate obvious text instructions without adding visual context.
192
+
- Screenshots that include sensitive workspace data, private repo names, tokens, customer data, or personal information.
193
+
- Images with stale UI labels, hidden feature flags, or unfinished internal-only surfaces.
194
+
195
+
#### Screenshot sizing standards
196
+
Use consistent screenshot widths so docs pages feel visually balanced. Crop unnecessary empty space before resizing, then choose the closest standard size.
197
+
198
+
**Standard widths:**
199
+
-**Large screenshots: default content width** — Use normal `<figure>` or Markdown image rendering for full-window, full-pane, or broad product-surface screenshots where the surrounding layout matters. In legacy GitBook screenshots, this was usually `563px`.
200
+
-**Medium screenshots: ~375px** — Use for narrow UI surfaces such as popovers, command menus, side panes, dropdowns, and focused interaction flows. This is the preferred constrained size for most small Warp UI screenshots.
201
+
-**Small screenshots: ~300-350px** — Use for tightly cropped controls, chips, buttons, tooltips, and small menus. Use a smaller width only when the UI remains legible and the crop is intentionally compact.
202
+
203
+
**Rules:**
204
+
-**Avoid arbitrary widths** — Choose the nearest standard size instead of one-off values. If a screenshot needs a different size, the reason should be clear from the UI being shown.
205
+
-**Keep sequences consistent** — Screenshots in the same section or step sequence should use the same width unless they show meaningfully different UI surfaces.
206
+
-**Preserve legibility** — Text in the screenshot must remain readable at the chosen size on the docs page.
207
+
-**Prefer the default figure size for large screenshots** — Only constrain width when the screenshot is a narrow UI element that looks oversized at full content width.
208
+
180
209
#### Image caption guidelines
181
210
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
211
@@ -558,6 +587,8 @@ Product feature names retain their standard capitalization. Match the exact casi
558
587
-**Codebase Context** - Warp indexes your Git-tracked codebase to help Agents understand your code.
559
588
-**Admin Panel** - Team management surface for controlling members, roles, and billing.
560
589
-**Agent Management Panel** - Interface for viewing and managing running agents (not "agent dashboard" or "agent manager").
590
+
-**Agent Memory** - Persistent, cross-harness memory layer for Oz agents that captures durable facts, decisions, and outcomes across conversations (currently in research preview). Capitalize as a feature name; use lowercase "memory store" for individual stores.
591
+
-**Handoff** - Feature for moving agent work between a local Warp session and the cloud, or continuing a finished cloud run; supports local-to-cloud, cloud-to-cloud, and cloud-to-local. Capitalize as a feature name; lowercase "hand off" only as a verb.
561
592
562
593
### Oz terminology
563
594
@@ -615,8 +646,10 @@ Product feature names retain their standard capitalization. Match the exact casi
615
646
### Billing and credits
616
647
-**credits** (lowercase, not "AI credits") - the unit of usage for AI features in Warp
617
648
-**Add-on Credits** (capitalized as a product feature name)
618
-
-**Cloud Agent Credits** (capitalized as a billing feature name)
619
-
-**plan credits** - credits included with a subscription plan
649
+
-**compute credits** (lowercase common noun; capitalize the first letter only at the start of a sentence or bullet) - the compute bucket; consumed when an agent run uses Warp-hosted compute. Used alongside AI credits and platform credits when describing credit types.
650
+
-**cloud agent credits** (lowercase common noun; capitalize the first letter only at the start of a sentence or bullet) - credits consumed by cloud agents (in contrast with local agent credits). Refers to the same compute bucket as compute credits; pick the term that fits the framing.
651
+
-**platform credits** (lowercase common noun; capitalize the first letter only at the start of a sentence or bullet) - the platform-infrastructure bucket
652
+
-**Warp credits** - credits included with a subscription plan. Use in user-facing copy rather than "plan credits."
620
653
- Use "credit" or "credits" without the "AI" prefix throughout documentation
0 commit comments