Skip to content

Web docs: introduce V1 sandbox docs; move legacy runtime/API to Web V0 - #275

Merged
enyst merged 11 commits into
mainfrom
docs-v1-web-and-v0-legacy
Jan 29, 2026
Merged

enyst merged 11 commits into
mainfrom
docs-v1-web-and-v0-legacy

Conversation

@enyst

@enyst enyst commented Jan 26, 2026 •

Copy link
Copy Markdown
Member

HUMAN: This PR proposes a first update for OpenHands-Web docs, to address the confusion in the community:

  • rename Web -> Web (V0) tab
  • move V0 runtimes -> Web (V0) runtimes
  • move V0 API -> API (V0)
  • create sandbox pages under Web tab
  • create a placeholder overview page for V1 API under Web tab

I have checked the mintlify deployment for the new and moved pages.


Summary

  • Add a new Web_V0 tab to keep legacy V0 web documentation out of the primary Web tab.
  • Move and rename legacy V0 docs:
    • openhands/usage/runtimes/* → openhands/usage/v0/runtimes/V0_*
    • openhands/usage/advanced/configuration-options → openhands/usage/v0/advanced/V0_configuration-options
    • openapi/openapi.json → openapi/V0_openapi.json
  • Add new V1 pages with normal names:
    • openhands/usage/sandboxes/* (Docker / Process / Remote)
    • openhands/usage/api/v1 (V1 API overview)
    • new V1-focused openhands/usage/advanced/configuration-options
  • Update navigation + redirects so old /openhands/usage/runtimes/* URLs land on the V1 sandbox docs (or the V0 pages for third-party runtimes).

Why

OpenHands V1 uses sandboxes (including a local process option) rather than the legacy “runtime” terminology. The previous docs prominently surfaced V0 runtime and V0 API material, which is confusing for users.

Notes / Follow-ups

  • The V1 sandbox docs are intentionally concise; we can expand with more concrete configuration examples once we align on the supported knobs for Process/Remote selection in the launcher/UI.
  • Legacy REST API OpenAPI remains available under Web_V0.

Tests

  • python -m json.tool docs.json
  • python -m pytest -q

@enyst can click here to continue refining the PR

Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
@enyst
enyst marked this pull request as ready for review January 26, 2026 10:42
@enyst
enyst requested review from mamoodi and tofarr as code owners January 26, 2026 10:42
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
@enyst enyst changed the title Web docs: introduce V1 sandbox docs; move legacy runtime/API docs to Web_V0 Web docs: introduce V1 sandbox docs; move legacy runtime/API to Web V0 Jan 26, 2026
Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
@openhands-ai

openhands-ai Bot commented Jan 29, 2026

Copy link
Copy Markdown

Looks like there are a few issues preventing this PR from being merged!

  • GitHub Actions are failing:
    • .github/workflows/sync-agent-sdk-openapi.yml
    • .github/workflows/sync-docs-code-blocks.yml

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #275 at branch `docs-v1-web-and-v0-legacy`

Feel free to include any additional details that might help me get this PR into a better state.

You can manage your notification settings

@enyst
enyst merged commit 6ef0f37 into main Jan 29, 2026
4 checks passed
@enyst
enyst deleted the docs-v1-web-and-v0-legacy branch January 29, 2026 15:14

This branch was successfully deployed

1 active deployment
staging — 79f447bb Deployed Jan 29, 2026 by mintlify[bot]
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.

2 participants