Skip to content

Document SDK ownership and boundary decisions#997

Merged
smolpaws merged 2 commits intodevelopfrom
document-sdk-ownership-and-boundaries
Mar 12, 2026
Merged

Document SDK ownership and boundary decisions#997
smolpaws merged 2 commits intodevelopfrom
document-sdk-ownership-and-boundaries

Conversation

@smolpaws
Copy link
Collaborator

@smolpaws smolpaws commented Mar 12, 2026

Summary

  • document packages/agent-sdk as the canonical shared TypeScript runtime source
  • record the current VS Code-coupled touchpoints instead of pretending the package is extension-only
  • note the current published-package distribution path used by the convergence work

Validation

  • documentation-only change
  • reviewed against the active convergence plan and the current cross-repo runtime usage in smolpaws and enyst-smolpaws

Open with Devin

Summary by CodeRabbit

  • Documentation
    • Clarified the agent SDK as the canonical TypeScript runtime shared across multiple applications while maintaining optional VS Code integrations.
    • Updated documentation to reflect the TypeScript SDK's role as the authoritative runtime source.
    • Added documentation outlining runtime convergence strategy, ownership structure, and distribution approach.

Record that packages/agent-sdk is the canonical shared TypeScript runtime source, capture the remaining VS Code-coupled touchpoints, and note the current published-package distribution path for the convergence work.

Co-authored-by: openhands <openhands@all-hands.dev>
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly updates the documentation for the @smolpaws/agent-sdk package. It redefines the SDK's role from a VS Code-exclusive component to the canonical shared TypeScript runtime for OpenHands, used across multiple projects. The changes clarify ownership, delineate boundaries, and identify existing VS Code-specific integrations, providing a roadmap for future development and convergence.

Highlights

  • SDK Canonical Source: The @smolpaws/agent-sdk is now documented as the canonical shared TypeScript runtime source, moving beyond its previous VS Code-only scope.
  • VS Code Touchpoints: Current VS Code-coupled integrations within the SDK are explicitly recorded, acknowledging their presence while emphasizing the runtime's broader applicability.
  • Distribution Path: The established published-package distribution path for the SDK is noted, guiding future convergence efforts.
Changelog
  • packages/agent-sdk/AGENTS.md
    • Updated the "Overview" section to reflect the @smolpaws/agent-sdk as the canonical shared TypeScript runtime, no longer treated as VS Code-only.
  • packages/agent-sdk/docs/python-parity.md
    • Modified the introductory paragraph to describe the TypeScript SDK as the "canonical TypeScript runtime source" and a "transpilation-oriented sibling" of the Python SDK.
  • packages/agent-sdk/docs/runtime-convergence.md
    • Added a new document detailing the ownership and boundary decisions for the TypeScript OpenHands runtime, including its canonical source, application roles, phase 1 boundary decisions, audited VS Code-coupled touchpoints, current distribution path, and remaining open items for convergence.
Activity
  • No human activity (comments, reviews, approvals) has been recorded on this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 12, 2026

Warning

Rate limit exceeded

@smolpaws has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 22 minutes and 16 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7d171668-ad2d-4e6e-abe7-47d497b1d443

📥 Commits

Reviewing files that changed from the base of the PR and between 5b6e976 and def8ca1.

📒 Files selected for processing (2)
  • packages/agent-sdk/AGENTS.md
  • packages/agent-sdk/docs/python-parity.md
📝 Walkthrough

Walkthrough

Documentation updates clarify the @smolpaws/agent-sdk package as the canonical TypeScript runtime shared across OpenHands-Tab, smolpaws, and enyst-smolpaws, removing VS Code-specific scope restrictions and establishing ownership boundaries and distribution paths.

Changes

Cohort / File(s) Summary
Agent SDK Documentation
packages/agent-sdk/AGENTS.md, packages/agent-sdk/docs/python-parity.md
Updated overview and descriptions to establish agent-sdk as canonical shared runtime across multiple projects, removing previous VS Code-specific scope language and clarifying relationship with Python SDK as transpilation-oriented sibling.
Runtime Convergence Reference
packages/agent-sdk/docs/runtime-convergence.md
New documentation detailing canonical ownership, phase 1 constraints, audited VS Code touchpoints, recommended distribution via @smolpaws/agent-sdk package, and identified open items for future work.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related issues

Possibly related PRs

Suggested labels

codex

Poem

🐰 A rabbit hops through the codebase wide,
Declaring the SDK as the truth, our guide,
No more VS Code walls to confine,
One runtime shared—all projects align! ✨
Convergence achieved, the boundaries shine.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Document SDK ownership and boundary decisions' accurately reflects the primary objective of the PR, which is to document that the agent-sdk is the canonical shared runtime source and record VS Code-coupled touchpoints.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch document-sdk-ownership-and-boundaries

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation to reflect that the @smolpaws/agent-sdk is now the canonical shared TypeScript runtime, no longer scoped to just the VS Code extension. A new document, runtime-convergence.md, is added to detail the ownership, boundaries, and VS Code-coupled touchpoints. The changes are clear and well-documented.

coderabbitai[bot]

This comment was marked as resolved.

Align the contributor guidance with the shared-runtime ownership model and soften the parity-guide language so it does not imply a mechanical transpilation pipeline.

Co-authored-by: openhands <openhands@all-hands.dev>
@github-actions
Copy link

🔧 VSCode Extension Built Successfully

• File: openhands-tab-0.9.0.vsix (545 KB)
• Download: https://github.com/enyst/OpenHands-Tab/actions/runs/22982916095

To install:

  1. Download the artifact from the run page above
  2. VS Code → Command Palette → "Extensions: Install from VSIX..."
  3. Select the downloaded .vsix

Built with Node 22. Commit 3d208f2.

@smolpaws smolpaws merged commit 0334a99 into develop Mar 12, 2026
8 of 17 checks passed
@smolpaws smolpaws deleted the document-sdk-ownership-and-boundaries branch March 12, 2026 09:44
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.

1 participant