From fe40b9078ad623e01c802dd1d777730cb77fcccd Mon Sep 17 00:00:00 2001 From: Hong Yi Chen Date: Mon, 18 May 2026 21:52:57 -0700 Subject: [PATCH] Audit pass: wire new orchestration-launch pages into sidebar; tidy stale terminology Audit pass over the three PRs merged into hyc/orchestration-launch (#83 Platform Credits, #87 Harnesses, #88 Agent identities) to catch wiring and cross-reference issues before rollout. Sidebar wiring (src/sidebar.ts): - Under 'Oz Cloud Agents & Orchestration', add 'Agent identities' (slug agent-platform/cloud-agents/agents) after Managing cloud agents, and a new collapsed 'Harnesses' subsection (Overview, Warp Agent, Claude Code, Codex, Authentication) after Secrets and before MCP servers. - Under 'Plans and billing', add 'Platform credits' after Add-on Credits. Terminology / cross-reference (one-line tweaks): - external-authentication-required.mdx:104: replace the inline '(service account)' parenthetical with 'bound to an [agent identity](...)'. Matches the alias formalized in agents.mdx and the existing phrasing in federate.mdx and cli/index.mdx. - cloud-agents/overview.mdx Learn more: add two bullets so the new Harnesses overview and Agent identities pages are discoverable from the parent overview. Validation: - check_links --internal-only: 0 broken across 2,495 internal links (up 3 from the 2,492 baseline, matching the 3 new links added). - style_lint --changed: 14 warnings, identical to baseline (all pre-existing proper-name false positives in pricing-faqs.mdx, bring-your-own-api-key.mdx, etc.). - npm run build: succeeds; 326 HTML files generated. Co-Authored-By: Oz --- .../docs/agent-platform/cloud-agents/overview.mdx | 2 ++ .../errors/external-authentication-required.mdx | 2 +- src/sidebar.ts | 13 +++++++++++++ 3 files changed, 16 insertions(+), 1 deletion(-) diff --git a/src/content/docs/agent-platform/cloud-agents/overview.mdx b/src/content/docs/agent-platform/cloud-agents/overview.mdx index d5fe8c02..2bcc4a16 100644 --- a/src/content/docs/agent-platform/cloud-agents/overview.mdx +++ b/src/content/docs/agent-platform/cloud-agents/overview.mdx @@ -144,6 +144,8 @@ If your credit balance reaches zero, cloud agent runs will not be able to execut * [Cloud agents quickstart](/agent-platform/cloud-agents/quickstart/) — run your first cloud agent with an environment in ~10 minutes. * [Oz Platform](/agent-platform/cloud-agents/platform/) — CLI, Oz API/SDK, orchestration, tasks, environments, hosts, integrations, and more. +* [Harnesses](/agent-platform/cloud-agents/harnesses/) — pick between Warp Agent, Claude Code, and Codex for any cloud agent run. +* [Agent identities](/agent-platform/cloud-agents/agents/) — team-scoped bot accounts that own and execute cloud agent runs. * [Skills as Agents](/agent-platform/cloud-agents/skills-as-agents/) — run agents based on reusable skill definitions from the CLI, web app, API, or on a schedule. * [Oz CLI](/reference/cli/) — shows how to run Oz agents in non-interactive mode from CI, scripts, or remote machines, including auth and common commands. * [Environments](/agent-platform/cloud-agents/environments/) — explains how environments provide the runtime context (repo, image, startup commands) for agent tasks. diff --git a/src/content/docs/reference/api-and-sdk/troubleshooting/errors/external-authentication-required.mdx b/src/content/docs/reference/api-and-sdk/troubleshooting/errors/external-authentication-required.mdx index 531b94d9..72433c1e 100644 --- a/src/content/docs/reference/api-and-sdk/troubleshooting/errors/external-authentication-required.mdx +++ b/src/content/docs/reference/api-and-sdk/troubleshooting/errors/external-authentication-required.mdx @@ -101,7 +101,7 @@ This error includes extra fields beyond the standard response format: 2. Ensure the app has access to all repositories listed in `inaccessible_repos`. 3. Retry the task. -If you are using a **team API key** (service account), ensure the Warp GitHub App is installed on the organization that owns the repositories. +If you are using a **team API key** bound to an [agent identity](/agent-platform/cloud-agents/agents/), ensure the Warp GitHub App is installed on the organization that owns the repositories. ### Account matching failed diff --git a/src/sidebar.ts b/src/sidebar.ts index c2e510a8..39a2aa9d 100644 --- a/src/sidebar.ts +++ b/src/sidebar.ts @@ -351,10 +351,22 @@ export const sidebarTopics: StarlightSidebarTopicsUserConfig = [ }, 'agent-platform/cloud-agents/environments', { slug: 'agent-platform/cloud-agents/managing-cloud-agents', label: 'Managing cloud agents' }, + { slug: 'agent-platform/cloud-agents/agents', label: 'Agent identities' }, { slug: 'agent-platform/cloud-agents/oz-web-app', label: 'Oz web app' }, { slug: 'agent-platform/cloud-agents/skills-as-agents', label: 'Skills as agents' }, { slug: 'agent-platform/cloud-agents/viewing-cloud-agent-runs', label: 'Viewing cloud agent runs' }, 'agent-platform/cloud-agents/secrets', + { + label: 'Harnesses', + collapsed: true, + items: [ + { slug: 'agent-platform/cloud-agents/harnesses', label: 'Overview' }, + { slug: 'agent-platform/cloud-agents/harnesses/warp-agent', label: 'Warp Agent' }, + { slug: 'agent-platform/cloud-agents/harnesses/claude-code', label: 'Claude Code' }, + { slug: 'agent-platform/cloud-agents/harnesses/codex', label: 'Codex' }, + { slug: 'agent-platform/cloud-agents/harnesses/authentication', label: 'Authentication' }, + ], + }, { slug: 'agent-platform/cloud-agents/mcp', label: 'MCP servers' }, { slug: 'agent-platform/cloud-agents/deployment-patterns', label: 'Deployment patterns' }, { slug: 'agent-platform/cloud-agents/warp-hosting', label: 'Warp-hosted agents' }, @@ -502,6 +514,7 @@ export const sidebarTopics: StarlightSidebarTopicsUserConfig = [ { slug: 'support-and-community/plans-and-billing/plans-pricing-refunds', label: 'Plans, Pricing, & Refunds' }, 'support-and-community/plans-and-billing/credits', 'support-and-community/plans-and-billing/add-on-credits', + { slug: 'support-and-community/plans-and-billing/platform-credits', label: 'Platform credits' }, 'support-and-community/plans-and-billing/bring-your-own-api-key', 'support-and-community/plans-and-billing/overages-legacy', 'support-and-community/plans-and-billing/pricing-faqs',