Add Narrative-First V0 to V1 Migration Guide (Alternative to #362)#363
Draft
jpshackelford wants to merge 2 commits intomainfrom
Draft
Add Narrative-First V0 to V1 Migration Guide (Alternative to #362)#363jpshackelford wants to merge 2 commits intomainfrom
jpshackelford wants to merge 2 commits intomainfrom
Conversation
This alternative approach restructures the migration guide to lead with a step-by-step narrative walkthrough, with reference tables moved to the end for lookup purposes. Structure: 1. Overview (brief architecture change + benefits accordion) 2. Migration Walkthrough (6 steps with V0→V1 examples) - Step 1: Create and Start a Conversation - Step 2: Track Conversation Startup - Step 3: Work with Events and Messages - Step 4: Manage Sandbox Lifecycle - Step 5: Access the Agent Server - Step 6: Handle Files and Workspace 3. Quick Reference: Endpoint Mapping (tables) 4. Agent Server API Reference 5. Known Gaps and Workarounds 6. Authentication Summary 7. Additional Resources Based on feedback from OpenHands/OpenHands#12578. Co-authored-by: openhands <openhands@all-hands.dev>
- Add link to App Server OpenAPI spec (openapi.json) in Additional Resources - Add new section explaining how to access Agent Server Swagger docs and OpenAPI spec - Includes step-by-step instructions for getting Agent Server URL from sandbox Co-authored-by: openhands <openhands@all-hands.dev>
5 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR provides an alternative approach to the migration guide in #362. The key difference is the narrative-first structure that leads with a step-by-step walkthrough rather than reference tables.
Comparison with PR #362
Structure
Key Improvements
Rationale
Based on feedback that a narrative migration flow is important for users. This approach addresses @enyst's "Typical Migration Flow" suggestion from #12578:
Related