Implement Agent Canvas Documentation#522
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. |
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 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:
- Add a
.agents/skills/custom-codereview-guide.mdfile to your branch (or edit it if one already exists) with the/codereviewtrigger 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.- Re-request a review - the reviewer reads guidelines from the PR branch, so your changes take effect immediately.
- 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
/iterateto 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
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:
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
llms.txtandllms-full.txtoutput to include the new docs structureNew Agent Canvas Pages
openhands/usage/agent-canvas/overview.mdxopenhands/usage/agent-canvas/setup.mdxopenhands/usage/agent-canvas/backends.mdxopenhands/usage/agent-canvas/development.mdxopenhands/usage/agent-canvas/llm-profiles.mdxopenhands/usage/agent-canvas/customize-and-settings.mdxopenhands/usage/agent-canvas/automations.mdxopenhands/usage/agent-canvas/self-hosting.mdxopenhands/usage/agent-canvas/troubleshooting.mdxExisting Docs Updated
docs.jsonoverview/introduction.mdxoverview/quickstart.mdxoverview/model-context-protocol.mdxoverview/skills.mdxenterprise/enterprise-vs-oss.mdxopenhands/usage/run-openhands/local-setup.mdxopenhands/usage/run-openhands/gui-mode.mdxopenhands/usage/cli/gui-server.mdxopenhands/usage/settings/integrations-settings.mdxopenhands/usage/advanced/custom-sandbox-guide.mdxopenhands/usage/v0/advanced/V0_configuration-options.mdxopenhands/usage/v0/runtimes/V0_overview.mdxAGENTS.mdllms.txtllms-full.txt