From 5eb0e5afcfe01f45594444d43e334d75c9dc156f Mon Sep 17 00:00:00 2001 From: neubig Date: Sun, 23 Aug 2026 15:26:31 +0000 Subject: [PATCH 1/2] docs: document OpenHands repository boundaries Clarify source repository ownership for the unified documentation site. Fixes #748 Co-authored-by: openhands --- .agents/skills/code-review.md | 7 ++++++- AGENTS.md | 13 +++++++++++++ README.md | 6 ++++++ 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/.agents/skills/code-review.md b/.agents/skills/code-review.md index ede425164..145c61579 100644 --- a/.agents/skills/code-review.md +++ b/.agents/skills/code-review.md @@ -94,7 +94,6 @@ Include a "Source Verification" section that lists the key claims verified and t | Legacy skills with `trigger=None` are included in the initial system prompt and remain in LLM context for subsequent turns | ✅ | [agent.py#L150](permalink) | | `load_skills_from_dir()` returns tuple of (skills, repo_skills) | ✅ | [context.py#L85](permalink) | | AgentSkills format uses progressive disclosure | ❌ Incorrect | [agent.py#L200](permalink) shows... | -``` If you cannot find source code to verify a documentation claim, explicitly flag it: @@ -103,6 +102,12 @@ If you cannot find source code to verify a documentation claim, explicitly flag This should be verified before merging. ``` +## Repository boundaries + +Verify that documentation changes belong in this repository rather than a source repository. `OpenHands/OpenHands` owns Agent Canvas, `OpenHands/software-agent-sdk` owns the SDK/Agent Server and canonical API, `OpenHands/typescript-client` owns typed browser API access, `OpenHands/automation` owns scheduling and dispatch, and `OpenHands/extensions` owns reusable skills, plugins, automations, and integrations. + +If a PR is opened in the wrong repository, explicitly recommend that it may need to be closed and moved to the repository that owns the change rather than merged here. Every PR must follow this repository's review guidance. + ## Review Decisions You **must** use the correct GitHub review `event` value when submitting your review. diff --git a/AGENTS.md b/AGENTS.md index 8d30cf70b..0c2f8592b 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -26,6 +26,19 @@ The site is built with **Mintlify** and deployed automatically by Mintlify on pu - `.agents/skills/` — prompt extensions for agents editing this repo (legacy: `.openhands/skills/`; formerly `microagents`) - `tests/` — pytest checks for docs consistency (notably LLM pricing docs) +## Cross-Repository Boundaries + +This repository owns the unified documentation site and documentation-specific tooling. The documented source repositories have distinct responsibilities: + +- [`OpenHands/OpenHands`](https://github.com/OpenHands/OpenHands) owns Agent Canvas UI and local-stack orchestration. +- [`OpenHands/software-agent-sdk`](https://github.com/OpenHands/software-agent-sdk) owns the Python SDK, Agent Server, agent/tool behavior, conversations, workspaces, events, and canonical API. +- [`OpenHands/typescript-client`](https://github.com/OpenHands/typescript-client) owns the browser-compatible typed Agent Server client. +- [`OpenHands/automation`](https://github.com/OpenHands/automation) owns scheduling, webhooks, run history, dispatch, and sandbox lifecycle orchestration. +- [`OpenHands/extensions`](https://github.com/OpenHands/extensions) owns reusable skills, plugins, automations, and integrations. + +Documentation should describe these boundaries accurately. If a documentation PR is opened in the wrong source repository, explicitly recommend closing and moving it to the repository that owns the change. PRs must follow this repository's applicable code-review guidance. + + ## llms.txt / llms-full.txt (V1-only) diff --git a/README.md b/README.md index a1a4ebf0d..a0a257911 100644 --- a/README.md +++ b/README.md @@ -26,3 +26,9 @@ mint dev ## Deployment The documentation site is automatically deployed via Mintlify when changes are pushed to the main branch. + +## Repository boundaries + +This site documents a multi-repository OpenHands system. [`OpenHands/OpenHands`](https://github.com/OpenHands/OpenHands) owns Agent Canvas, [`OpenHands/software-agent-sdk`](https://github.com/OpenHands/software-agent-sdk) owns the Python SDK and Agent Server, [`OpenHands/typescript-client`](https://github.com/OpenHands/typescript-client) owns the browser client for the Agent Server API, [`OpenHands/automation`](https://github.com/OpenHands/automation) owns scheduling and dispatch, and [`OpenHands/extensions`](https://github.com/OpenHands/extensions) owns reusable skills, plugins, automations, and integrations. + +The usual API flow is SDK/Agent Server → OpenAPI contract → TypeScript client → Agent Canvas. Documentation should preserve these ownership boundaries; a PR opened in the wrong repository should be closed and moved to the repository that owns the change. From d5d4b6c327107a29c49360c0a2c46dc47bffb68e Mon Sep 17 00:00:00 2001 From: Devin Date: Mon, 24 Aug 2026 12:34:50 -0400 Subject: [PATCH 2/2] Update code review guidelines for documentation claims Fix missing closing tics for the source verification example --- .agents/skills/code-review.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.agents/skills/code-review.md b/.agents/skills/code-review.md index 145c61579..4dbbe3214 100644 --- a/.agents/skills/code-review.md +++ b/.agents/skills/code-review.md @@ -94,6 +94,7 @@ Include a "Source Verification" section that lists the key claims verified and t | Legacy skills with `trigger=None` are included in the initial system prompt and remain in LLM context for subsequent turns | ✅ | [agent.py#L150](permalink) | | `load_skills_from_dir()` returns tuple of (skills, repo_skills) | ✅ | [context.py#L85](permalink) | | AgentSkills format uses progressive disclosure | ❌ Incorrect | [agent.py#L200](permalink) shows... | +``` If you cannot find source code to verify a documentation claim, explicitly flag it: