Conversation
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>
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>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Well-structured, comprehensive documentation that follows all repository guidelines.
This guide is production-ready. Clear organization, good examples, proper navigation integration, and follows the established SDK documentation patterns.
| tags={"variant": "B"}, | ||
| ) | ||
| fork.run() # Same history, different model | ||
| ``` |
There was a problem hiding this comment.
🟢 Acceptable: The line range focus={8-11} might not precisely match the code block lines (the fork call appears to be lines 4-8). Mintlify should handle this gracefully, but if the highlighting looks off in preview, consider adjusting to focus={4-8}.
|
|
||
| - **[Persistence](/sdk/guides/convo-persistence)** — Save and restore conversation state | ||
| - **[Pause and Resume](/sdk/guides/convo-pause-and-resume)** — Control execution flow | ||
| - **[Agent Server](/sdk/guides/agent-server/overview)** — Deploy agents with the REST API |
There was a problem hiding this comment.
🟢 Nice touch: Including the full ready-to-run example with assertions that verify fork behavior works well. The example is self-contained and educational.
Co-authored-by: openhands <openhands@all-hands.dev>
4 participants
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:
POST /api/conversations/{id}/forkNavigation: Added
sdk/guides/convo-forkas the first item in the "Conversation Features" group indocs.json.Related: This documents the feature implemented in OpenHands/software-agent-sdk#2841 (closes OpenHands/software-agent-sdk#2840).
Note: Branch name matches the SDK PR branch (
openhands/conversation-fork) so thecheck-documented-examplesCI can discover the docs.This PR was created by an AI agent (OpenHands) on behalf of the user.