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
{{ message }}
Repository navigation
Commit 685c791
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .agents/references/terminology.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -259,7 +259,6 @@ Not every "Oz" in the docs is stale. These are deliberate and correct until
259
259
-**The `oz` binary** and every `oz <command>` invocation. Commands inside code
260
260
fences are never rewritten. `{VARS.WARP_AGENT_CLI}` renders "Oz CLI".
261
261
-**`oz.warp.dev`** and the Oz v1 web app. `{VARS.WEB_APP}`, `{VARS.WEB_APP_URL}`.
262
-
-**`{VARS.API_SDK_NAME}`**, which renders "Oz API & SDK".
263
262
-**`oz-agent-worker`, `oz-agent-action`, `oz-skills`** — repository and package
264
263
names, not product names. These may never change.
265
264
-**The `@oz-agent` GitHub handle.** Handles are strings the product owns;
@@ -273,9 +272,10 @@ Not every "Oz" in the docs is stale. These are deliberate and correct until
273
272
274
273
## Platform terms
275
274
276
-
-**Agent API** — The HTTP API for triggering and inspecting Platform runs programmatically.
275
+
-**Warp Platform API** — The HTTP API for sending work to factories and triggering and inspecting cloud agent runs programmatically.
276
+
*Usage note:* Use `{VARS.WARP_PLATFORM_API}` in body prose and `{{WARP_PLATFORM_API}}` in frontmatter.
277
277
278
-
-**Artifacts** — Files an agent produces during a run and uploads to Warp: screenshots, generated reports, build outputs, logs, or any other file the agent saves alongside its conversation. Retrieved with `oz artifact` (see the [Artifacts CLI reference](/reference/cli/artifacts/)) and one of the three data categories in [self-hosted agent data storage](/platform/data-storage/).
278
+
-**Artifacts** — Files an agent produces during a run and uploads to Warp: screenshots, generated reports, build outputs, logs, or any other file the agent saves alongside its conversation. Retrieved with `oz artifact` (see the [Artifacts CLI reference](/agents/cli/oz-cli/artifacts/)) and one of the three data categories in [self-hosted agent data storage](/platform/data-storage/).
279
279
*Usage note:* Capitalize as **Artifacts** when referring to the named category (a CLI reference page, an Admin Panel storage category); lowercase "artifacts" as the generic noun for the files themselves.
280
280
281
281
-**Auth** — The agent settings field for choosing or creating the credential (a team-owned secret) a harness uses to authenticate with its provider, matched to that harness's supported credential types (Anthropic keys for Claude Code, an OpenAI key for Codex).
@@ -297,7 +297,7 @@ Not every "Oz" in the docs is stale. These are deliberate and correct until
297
297
-**Run** — The tracked unit of work for a run, including status and outputs.
298
298
*Usage note:* Use when describing observability, history, and auditability.
299
299
300
-
-**SDK** — Official client libraries for the Agent API (for example, TypeScript SDK, Python SDK).
300
+
-**SDK** — Official client libraries for the Warp Platform API (for example, TypeScript SDK, Python SDK).
301
301
*Usage note:* Spell out the language on first mention.
302
302
303
303
-**Trigger** — The event that starts a run (Slack mention, schedule, CI event, API call).
@@ -306,7 +306,7 @@ Not every "Oz" in the docs is stale. These are deliberate and correct until
306
306
307
307
-**Warp CLI** — Ambiguous since the Warp Agent CLI launched; avoid the bare term. Use "Oz CLI" for the `oz` binary that runs and manages cloud agents (formerly called `warp-cli`), or "Warp Agent CLI" for the `warp` binary that runs the Warp Agent in any terminal.
308
308
309
-
-**Automation Platform** — Warp's cloud agent platform, covering environments, integrations, orchestration, self-hosting, and the Agent API/SDK. Renamed from "Oz" on 2026-08-18.
309
+
-**Automation Platform** — Warp's cloud agent platform, covering environments, integrations, orchestration, self-hosting, and the Warp Platform API and SDKs. Renamed from "Oz" on 2026-08-18.
310
310
*Usage note:* See "Automation Platform terminology" above for the full entry and the article rule. Always write it as `{VARS.WARP_AUTOMATION_PLATFORM}` / `{{WARP_AUTOMATION_PLATFORM}}`, never as a literal string, so a future rename stays a one-line change.
311
311
312
312
-**Direct backend** — The self-hosted worker backend that runs cloud agent tasks directly on the worker host, without Docker or Kubernetes. One of three self-hosting backends alongside the Docker and Kubernetes backends.
@@ -375,7 +375,7 @@ Docs match the screen; the fix belongs in the app.
375
375
*Usage note:* Lowercase common noun. Distinct from the **Automation Platform**, the product; and from a **trigger**, the event that fires an automation.
376
376
377
377
-**runner** — A factory resource, defined by a `runners/<name>.yaml` file, that defines the compute a run executes on: operating system, architecture, sandbox image, and instance shape. Agents and automations select a runner by name, or inherit the factory's default.
378
-
*Usage note:* Lowercase common noun. Scoped to a factory's definition; distinct from the general [cloud agent runner](/platform/runners/) reference, which covers the same concept for standalone cloud agents outside a factory.
378
+
*Usage note:* Lowercase common noun. Scoped to a factory's definition; distinct from the general [cloud agent runner](/factories/runners/) reference, which covers the same concept for standalone cloud agents outside a factory.
379
379
380
380
-**Scorer** — A configured LLM judge, scoped per factory to chosen agents and sampled at a set rate, that classifies completed runs against criteria you write, such as "did the agent run the tests before opening a PR?" A Scorer assigns a label (a classification with a score), not a freeform numeric grade. Feeds the **Dashboard** page's Scorer cards, benchmarks, and Self-improvement.
381
381
*Usage note:* Capitalize "Scorer"/"Scorers" when referring to the feature or a configured instance ("create a Scorer," "Scorer cards"); lowercase only for a generic instance count or file listing ("two scorers," alongside "skills" in an example tree). Say "classify," never "grade" — the docs draw this distinction deliberately. The unit a Scorer evaluates is a **run** (a single agent execution), not a "conversation" or "completed work." `measure-and-improve/scorers.mdx` is the canonical page for what a Scorer is and how to configure one; other pages link there rather than repeating the definition.
Copy file name to clipboardExpand all lines: .agents/skills/docs-seo-audit/SKILL.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -154,7 +154,7 @@ Some page titles are intentionally short or specific and must **not** be changed
154
154
-**`src/content/docs/terminal/windows/split-panes.mdx`** (`Split panes`) — Same rationale: the section header disambiguates the terminal context. The `title_too_short` warning is intentionally suppressed. Do not rename to "Terminal split panes".
155
155
-**`src/content/docs/terminal/windows/tab-configs.mdx`** (`Tab Configs`) — Same rationale: the section header disambiguates the terminal context. Additionally, "Tab Configs" is a proper feature name and should not be prefixed. The `title_too_short` warning is intentionally suppressed. Do not rename to "Terminal Tab Configs".
156
156
-**`src/content/docs/terminal/sessions/index.mdx`** (`Sessions`) — The sidebar section header ("Sessions") already provides terminal context. The `title_too_short` warning is intentionally suppressed. Do not rename to "Terminal sessions".
157
-
-**`src/content/docs/reference/cli/artifacts.mdx`** (`Artifacts`) — The Reference > CLI section provides context, and "Artifacts" matches the `oz artifact` resource that the page documents. The `title_too_short` warning is intentionally suppressed.
157
+
-**`src/content/docs/agents/cli/oz-cli/artifacts.mdx`** (`Artifacts`) — The Agents > CLI section provides context, and "Artifacts" matches the `oz artifact` resource that the page documents. The `title_too_short` warning is intentionally suppressed.
158
158
159
159
When the audit flags these pages for `title_too_short`, exclude them from your fix list and include a note in your report explaining they are intentional exceptions.
Copy file name to clipboardExpand all lines: .agents/skills/draft_guide/SKILL.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,7 +76,7 @@ When drafting a guide, check for relevant SEO and AEO data:
76
76
77
77
When a guide includes Oz CLI commands or GitHub Actions workflows using `warpdotdev/oz-agent-action`:
78
78
79
-
-**Verify Oz CLI commands against `/reference/cli/`.** Do not infer flag names or argument formats. Use only flags documented in the CLI reference. When in doubt, link to the reference page instead of showing a command.
79
+
-**Verify Oz CLI commands against `/agents/cli/oz-cli/`.** Do not infer flag names or argument formats. Use only flags documented in the CLI reference. When in doubt, link to the reference page instead of showing a command.
80
80
-**`oz-agent-action` input format**: `warp_api_key` is a `with:` input to the action, not an `env:` variable. `GITHUB_TOKEN` goes in `env:`. The correct pattern is:
81
81
```yaml
82
82
- uses: warpdotdev/oz-agent-action@v1
@@ -112,14 +112,14 @@ Before adding any internal documentation link:
112
112
113
113
- **Verify the target page exists.** Check `src/sidebar.ts` for sidebar entries and the corresponding file under `src/content/docs/` to confirm the page exists. Do NOT generate plausible-looking URLs to pages that don't exist.
114
114
- **If a target page is planned but not yet published**, link to the closest existing page and add a TODO comment with the intended future path: `<!-- TODO: Update to [future-path] once [page name] is live -->`
115
-
- **For third-party CLI agent pages**, the current paths are under `src/content/docs/agent-platform/cli-agents/` (e.g., `claude-code.mdx`, `codex.mdx`, `opencode.mdx`).
115
+
- **For third-party CLI agent pages**, the current paths are under `src/content/docs/agents/cli-agents/` (e.g., `claude-code.mdx`, `codex.mdx`, `opencode.mdx`).
116
116
117
117
## Cross-linking
118
118
119
119
Every guide should link to:
120
120
- At least one other guide in the Guides section
121
-
- Relevant feature documentation in the main docs (`src/content/docs/` or `src/content/docs/agent-platform/`)
122
-
- If applicable, pages in the Third-Party CLI Agents section (`src/content/docs/agent-platform/cli-agents/`)
121
+
- Relevant feature documentation in the main docs (`src/content/docs/` or `src/content/docs/agents/`)
122
+
- If applicable, pages in the Third-Party CLI Agents section (`src/content/docs/agents/cli-agents/`)
0 commit comments