Skip to content

docs: add Conversation.fork() guide#458

Closed
xingyaoww wants to merge 2 commits intomainfrom
openhands/conversation-fork-guide
Closed

docs: add Conversation.fork() guide#458
xingyaoww wants to merge 2 commits intomainfrom
openhands/conversation-fork-guide

Conversation

@xingyaoww
Copy link
Copy Markdown
Contributor

  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

Adds a new SDK guide page for Conversation.fork(), a first-class primitive for branching off an existing conversation for follow-up exploration without contaminating the original audit trail.

The guide covers:

  • Basic usage — fork a conversation, source isolation, deep-copy semantics
  • Agent replacement — fork with a different agent for A/B testing or tool-change scenarios
  • Tags and metadata — title and arbitrary tags on forks
  • Metrics reset — controlling whether cost/token stats carry over or start fresh
  • Agent-server REST endpointPOST /api/conversations/{id}/fork
  • Full ready-to-run example — demonstrates all fork features without requiring LLM calls

Navigation: Added sdk/guides/convo-fork as the first item in the "Conversation Features" group in docs.json.

Related: This documents the feature implemented in OpenHands/software-agent-sdk#2841 (issue #2840).


This PR was created by an AI agent (OpenHands) on behalf of the user.

@xingyaoww can click here to continue refining the PR

Add SDK guide page for the new Conversation.fork() primitive that lets
users branch off an existing conversation for follow-up exploration
without contaminating the original audit trail.

Covers:
  - Basic usage (fork, source isolation, deep-copy semantics)
  - Fork with a different agent (A/B testing, tool-change)
  - Tags, metadata, and metrics reset
  - Agent-server REST endpoint (POST /api/conversations/{id}/fork)
  - Full ready-to-run example (no LLM calls needed)

Added to Conversation Features nav group in docs.json.

Related SDK PR: OpenHands/software-agent-sdk#2841

Co-authored-by: openhands <openhands@all-hands.dev>
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 16, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Apr 16, 2026, 2:42 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Update the ready-to-run example to match the real-LLM version from
the SDK repo, and add the RunExampleCode shared snippet.

Co-authored-by: openhands <openhands@all-hands.dev>
Copy link
Copy Markdown
Contributor Author

Closing in favor of a new PR from branch openhands/conversation-fork (matching the SDK PR branch name so CI's check-examples can find the docs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants