docs: update repository boundaries and Agent Canvas architecture - #688
docs: update repository boundaries and Agent Canvas architecture#688DevinVinson wants to merge 9 commits into
Conversation
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. |
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: Engel Nyst <engel.nyst@gmail.com>
Co-authored-by: Engel Nyst <engel.nyst@gmail.com>
Clarified the requirement for an API key in the remote backend setup.
…aries Grounded to the PR diff: what moves where (Agent Canvas=client, Agent Server= runtime in the SDK repo, Automation Server=scheduler, Sandbox Server=community only), the two new pages, the consistent language shift, review notes, and a feline take. Linked from the Notebook index.
smolpaws
left a comment
smolpaws
left a comment
There was a problem hiding this comment.
🐾 Read this end to end — here's a show-me of what moves where, grounded to the diff: https://enyst.github.io/arch/docs-repo-migration-boundaries.html
Quick take (details + page-by-page notes on the page):
Direction is right. The old docs described a monolith that no longer exists. This consistently re-frames it into four honest nouns — Agent Canvas = client, Agent Server = runtime (and it lives in the SDK repo), Automation Server = scheduler, workspace/sandbox = the boundary. The strongest, most-needed edit is redefining "backend = Agent Server (+ optional Automation Server)" everywhere (intro, backends, architecture, sdk/arch/overview). The two new pages (agent-canvas/architecture.mdx, backend-setup/remote.mdx) carry the load and everything else re-points to them.
A few things worth a human eye before it leaves draft:
- Sandbox Server "community-driven, not a supported Canvas backend" — this is a genuine product call (it also reassigns the whole V1 API page), not just a rename. Worth an explicit maintainer yes.
cloud.mdx: "Easy Phone & Tablet Access so you can code on the go" reads like a marketing line dropped into a setup doc, and the capitalization is off-style./canvasURL split (docker/k8s: UI at:8000/canvas, backend base URL stays:8000) — worth confirming that matches the shipped ingress (it matches what I see running locally, FWIW).- Noise vs signal: the scary +1323/−898 in
llms-full.txtis generated output — the hand-written change is much smaller. - The two pricing-suite failures are pre-existing (they fetch a removed
OpenHands/utils/llm.py), not from this PR.
Overall: I'd approve the direction and do the page-by-page pass you already asked for — especially the architecture page's component/repo table, since that becomes the canonical thing everyone links to.
(Note: I reviewed the PR diff, not the rendered Mintlify preview.)
| Try it free by [signing in with your GitHub account](https://app.all-hands.dev) or [Check out the docs](/openhands/usage/cloud/openhands-cloud) | ||
| [OpenHands Cloud](/openhands/usage/cloud/openhands-cloud) is the managed commercial service for running OpenHands without operating your own backend and sandbox infrastructure. It provides hosted execution, integrations, collaboration, access controls, usage reporting, and budget management. | ||
|
|
||
| [Sign in with your GitHub account](https://app.all-hands.dev) to try it. |
There was a problem hiding this comment.
Out of curiosity, does this work now directly from app.all-hands.dev/canvas ?
3 participants
Summary
Review status
This is a first pass over the broad scope in #686. It still needs a full human review, preferably page by page, for product language, information architecture, technical accuracy, and the remaining decisions listed in the issue. Please keep this PR in draft until that review is complete.
The latest pass clarifies that Sandbox Server is community-driven and not a core or supported Agent Canvas backend. It also distinguishes a generic remote Agent Server from the managed Cloud and Enterprise platforms, whose control planes create the sandboxes that host Agent Server.
Validation
docs.jsonparses successfullygit diff --checkpassesllms.txtandllms-full.txtomit the obsolete backend/runtime architecture pagesKnown unrelated issue
The complete pricing test suite has two pre-existing errors because it fetches the removed
OpenHands/OpenHands/main/openhands/utils/llm.pypath. That separate pricing-source migration is not included here.Closes #686
This draft pull request was created by an AI agent (OpenHands) on behalf of the user.