Skip to content

Implement Agent Canvas Documentation#522

Open
DevinVinson wants to merge 5 commits into
mainfrom
docs/agent-canvas-docs
Open

Implement Agent Canvas Documentation#522
DevinVinson wants to merge 5 commits into
mainfrom
docs/agent-canvas-docs

Conversation

@DevinVinson
Copy link
Copy Markdown
Member

Summary

This PR introduces a new Agent Canvas (Beta) documentation section and repositions the docs so Agent Canvas is the primary path for local and self-hosted OpenHands usage.

It adds a dedicated set of Agent Canvas guides, updates overview and entry-point pages to point readers to Agent Canvas, and preserves the older Local GUI docs as Local GUI (Legacy) on their existing URLs.

Framing

Agent Canvas is now documented as:

  • the current Beta UI for local and self-hosted OpenHands
  • a frontend that can run against local, remote, or cloud-backed backends
  • the main place for conversations, backend management, settings, customization, and automations

At the same time, this PR keeps the previous Local GUI docs available for users on older workflows, but clearly labels them as legacy.

What This PR Does

  • adds a new Agent Canvas (Beta) section to the OpenHands docs navigation
  • introduces first-pass docs for the main Agent Canvas workflows
  • updates overview and quickstart pages to direct users to Agent Canvas instead of the older Local GUI flow
  • labels the older Local GUI docs as Local GUI (Legacy) and adds notes pointing readers to Agent Canvas
  • updates related cross-links so MCP, skills, and local/self-hosted references align with Agent Canvas terminology
  • refreshes generated llms.txt and llms-full.txt output to include the new docs structure

New Agent Canvas Pages

  • openhands/usage/agent-canvas/overview.mdx
  • openhands/usage/agent-canvas/setup.mdx
  • openhands/usage/agent-canvas/backends.mdx
  • openhands/usage/agent-canvas/development.mdx
  • openhands/usage/agent-canvas/llm-profiles.mdx
  • openhands/usage/agent-canvas/customize-and-settings.mdx
  • openhands/usage/agent-canvas/automations.mdx
  • openhands/usage/agent-canvas/self-hosting.mdx
  • openhands/usage/agent-canvas/troubleshooting.mdx

Existing Docs Updated

  • docs.json
  • overview/introduction.mdx
  • overview/quickstart.mdx
  • overview/model-context-protocol.mdx
  • overview/skills.mdx
  • enterprise/enterprise-vs-oss.mdx
  • openhands/usage/run-openhands/local-setup.mdx
  • openhands/usage/run-openhands/gui-mode.mdx
  • openhands/usage/cli/gui-server.mdx
  • openhands/usage/settings/integrations-settings.mdx
  • openhands/usage/advanced/custom-sandbox-guide.mdx
  • openhands/usage/v0/advanced/V0_configuration-options.mdx
  • openhands/usage/v0/runtimes/V0_overview.mdx
  • AGENTS.md
  • llms.txt
  • llms-full.txt

@DevinVinson DevinVinson requested a review from mamoodi as a code owner May 26, 2026 15:01
@DevinVinson DevinVinson removed the request for review from mamoodi May 26, 2026 15:01
@mintlify
Copy link
Copy Markdown

mintlify Bot commented May 26, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview May 26, 2026, 3:03 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

🟢 Good taste - Well-organized documentation with clear structure, appropriate deprecation handling, and strong security guidance.

STRENGTHS:

  • ✅ Excellent backward compatibility: legacy URLs preserved with clear deprecation notices
  • ✅ Strong security warnings in self-hosting documentation
  • ✅ Consistent internal linking: all cross-references validated
  • ✅ Clear progressive disclosure: overview → setup → advanced topics
  • ✅ AGENTS.md updated to reflect new structure
  • ✅ Valid JSON navigation configuration

[RISK ASSESSMENT]

  • [Overall PR] ⚠️ Risk Assessment: 🟡 MEDIUM

This is a large documentation restructure that repositions Agent Canvas as the primary local/self-hosted path. The execution is solid: backward compatibility is preserved, security warnings are prominent, and the content structure is logical. Main risks are broken links and rendering issues, both of which should be caught by CI (broken link checks) and Mintlify build validation. Content quality is high with clear explanations, appropriate warnings, and good cross-referencing.

VERDICT:
Worth merging: Well-executed documentation restructure with strong foundations

KEY INSIGHT:
The deprecation strategy (preserving URLs + clear "Legacy" labels + forward-pointing notes) is exemplary and should be the template for future product transitions.


Improve this review? If any feedback above seems incorrect or irrelevant to this repository, you can teach the reviewer to do better:

  1. Add a .agents/skills/custom-codereview-guide.md file to your branch (or edit it if one already exists) with the /codereview trigger and the context the reviewer is missing (e.g., "Security concerns about X do not apply here because Y"). See the customization docs for the required frontmatter format.
  2. Re-request a review - the reviewer reads guidelines from the PR branch, so your changes take effect immediately.
  3. When your PR is merged, the guideline file goes through normal code review by repository maintainers.

Resolve with AI? Install the iterate skill in your agent and run /iterate to automatically drive this PR through CI, review, and QA until it's merge-ready.

Was this review helpful? React with 👍 or 👎 to give feedback.


Was this automated review useful? React with 👍 or 👎 to this review to help us measure review quality.
Workflow run: https://github.com/OpenHands/docs/actions/runs/26456432207

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.

3 participants