Skip to content

Fast follow: orchestration launch docs updates#104

Merged
rachaelrenk merged 21 commits into
mainfrom
fast-follow/orchestration-launch-docs
May 20, 2026
Merged

Fast follow: orchestration launch docs updates#104
rachaelrenk merged 21 commits into
mainfrom
fast-follow/orchestration-launch-docs

Conversation

@rachaelrenk
Copy link
Copy Markdown
Contributor

@rachaelrenk rachaelrenk commented May 19, 2026

Summary

This PR collects fast-follow improvements from a human review of the orchestration launch docs. The updates make the new Agent Memory, cloud handoff, and third-party harness docs clearer, more scannable, more visually actionable, and better aligned with the docs style guide.

Changes

Screenshot and style guidance

  • Added screenshot placement and sizing guidance to AGENTS.md based on patterns from legacy GitBook docs.
  • Captured standards for when screenshots are useful, how to size full-page versus focused UI screenshots, and how to write captions/alt text.
  • Added standardized local-to-cloud handoff screenshots to the handoff overview and local-to-cloud guide, using docs-standard image widths and descriptive figure captions.
  • Replaced the initial screenshot crops with manually recropped source images while preserving standardized asset filenames.

Agent Memory docs

  • Refined agent-memory/index.mdx for clearer product framing, memory-store terminology, punctuation, and style-guide-aligned dash usage.
  • Kept Agent Memory (Research Preview) in the page title/sidebar for launch consistency while using lowercase research preview in body copy.
  • Clarified traceability/auditability wording without claiming an unverified UI location.
  • Reworked store descriptions and explicit-save wording so the feature behavior is more concrete.
  • Clarified the Agent Memory status reference in capabilities/skills.mdx.

CLI agent related pages

  • Normalized the Related pages sections in the Claude Code and Codex CLI agent docs so every link includes a short description.

Cloud handoff docs

  • Improved the handoff overview, local-to-cloud, and cloud-to-cloud docs with stronger answer-first opening paragraphs for AEO/citation use.
  • Reduced duplicated description/intro copy and tightened awkward phrasing around restored workspace state and failed patch application.
  • Converted buried or prose-heavy instructions into clearer procedural steps where appropriate.
  • Clarified UI naming, including using lowercase conversation panel in these handoff docs.
  • Clarified third-party cloud harness coverage for cloud-to-cloud handoff.
  • Preserved the new snapshots link from main while resolving the branch conflict in cloud-to-cloud.mdx.

Third-party harness authentication docs

  • Reworked the authentication intro to explain why Claude Code and Codex require Warp-managed provider credentials for cloud runs.
  • Updated Anthropic and OpenAI API-key procedures to match current provider UI labels and avoid brittle positional directions.
  • Replaced the unverified Warp desktop app key-icon instructions with the current harness-selection/auth-secret wording.
  • Linked the Oz web app new run flow directly from the Claude Code and Codex credential setup steps.

Review feedback and merge maintenance

  • Addressed agreed review feedback from HYC around Research Preview capitalization, redundant in Warp phrasing, conversation panel capitalization, and provider API-key instructions.
  • Deferred cloud-to-cloud handoff screenshots to a follow-up PR because those screenshots are not available yet.
  • Merged the latest main into this branch and resolved the resulting conflict.

Additional context

  • The PR is intentionally broad because it is the collection point for fast-follow fixes found during the launch-docs review.
  • Local-to-cloud handoff screenshots are included in this PR; cloud-to-cloud handoff screenshots should be added in a separate follow-up once available.
  • Please have the harness/authentication DRI verify the Warp desktop app flow for adding Claude Code/Codex harness auth secrets. During review, the current Cloud Agent UI did not show the previously documented key icon above the input, so the docs now describe selecting the Agent harness and adding/selecting the matching harness auth secret instead.

Testing

  • git diff --check
  • git diff --cached --check
  • npm --prefix /Users/rachaelrenk/Documents/Warp/docs run build — passed with existing non-fatal Astro prerender warnings.

Co-Authored-By: Oz oz-agent@warp.dev

Co-Authored-By: Oz <oz-agent@warp.dev>
@cla-bot cla-bot Bot added the cla-signed label May 19, 2026
@vercel
Copy link
Copy Markdown

vercel Bot commented May 19, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 20, 2026 1:02am

Request Review

@oz-for-oss
Copy link
Copy Markdown
Contributor

oz-for-oss Bot commented May 19, 2026

@rachaelrenk

I'm starting a first review of this pull request.

You can view the conversation on Warp.

I completed the review and no human review was requested for this pull request.

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

Copy link
Copy Markdown
Contributor

@oz-for-oss oz-for-oss Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overview

This PR adds screenshot placement and sizing guidance to the docs style guide. The additions are scoped to documentation authoring standards and align with the stated intent; the security pass found no concerns.

Concerns

  • No blocking concerns found.

Verdict

Found: 0 critical, 0 important, 0 suggestions

Approve

Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).

Powered by Oz

@rachaelrenk rachaelrenk self-assigned this May 19, 2026
Co-Authored-By: Oz <oz-agent@warp.dev>
rachaelrenk and others added 2 commits May 19, 2026 08:51
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
rachaelrenk and others added 2 commits May 19, 2026 08:57
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
rachaelrenk and others added 2 commits May 19, 2026 09:24
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Copy link
Copy Markdown
Collaborator

@hongyi-chen hongyi-chen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

a couple of small nits, but approving to unblock

@@ -1,79 +1,79 @@
---
title: Agent Memory (Research Preview)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we keep this as Research Preview just for consistency with marketing comms?

## Sending a follow-up

You don't take a separate "hand off" action — you send a follow-up from the Warp app, and the run continues. The handoff happens automatically when the original session has ended.
To continue an ended cloud run, open the run in Warp and send the next message in the conversation. When the original session has ended, Warp automatically starts a fresh cloud session and restores the prior workspace state.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be nice to include a screenshot here; we can tackle in a follow up PR

---

Handoff lets you move a unit of agent work between a local Warp session and the cloud, or continue a finished cloud run, without re-explaining the task. The receiving agent picks up the conversation history, your workspace state, and any conversation attachments from the prior session.
Handoff in Warp moves agent work between local Warp sessions and cloud agent runs without making you restart the task. Depending on the direction, Warp carries over conversation history, workspace changes, and attachments so the receiving agent can continue from the prior session instead of starting from scratch.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally, I don't think you need to describe things as "in Warp"

After you submit, the cloud agent applies your workspace snapshot and responds to your follow-up. The local conversation is not modified, so you can keep working in it locally or close it.

To check on the new run, open it from the [Runs page](https://oz.warp.dev/runs) in the Oz web app or the conversation panel.
To check on the new run, open it from the [Runs page](https://oz.warp.dev/runs) in the Oz web app or the Conversation Panel in the Warp app.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be capitalizing Conversational Panel? I think we can keep it lowercase? would like to keep this consistent throughout

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reverted to lowercase for now but we may want to address on a broader scale later on as other parts of the docs treat it as a named UI surface w/ title case. Noting as an observation, not a high priority right now!

1. Go to the [Anthropic Console](https://platform.claude.com/login?returnTo=/?) and sign in (or create an account).
2. Navigate to **API keys** and create a new key.
3. Make sure your account has API credits — Claude Code runs are billed against your Anthropic API balance.
2. In the top-right corner, click **Get API key**.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of giving absolute directions, we should just tell them to navigate to specific sections (i.e. if Anthropic changes the layout of this page)

Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
Co-Authored-By: Oz <oz-agent@warp.dev>
@rachaelrenk rachaelrenk merged commit 04c0c36 into main May 20, 2026
8 checks passed
@rachaelrenk rachaelrenk deleted the fast-follow/orchestration-launch-docs branch May 20, 2026 01:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants