docs: add Onboarding Agent Canvas section#533
Merged
Conversation
- Rename 'Onboarding OpenHands' group to 'Onboarding Agent Canvas' - Add agent-canvas docs (overview, setup, backends, llm-profiles, customize-and-settings, automations, self-hosting, development, troubleshooting) under Onboarding Agent Canvas - Move Hooks to Product Guides section - Update Quick Start to single 'Install OpenHands Agent Canvas' card with OpenHands Cloud as a bullet item 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. |
- Remove bullet points from Agent Canvas card in Quick Start - Add OpenHands Cloud as a single bullet below the card - Move Repository Customization to Product Guides, after Automations Co-authored-by: openhands <openhands@all-hands.dev>
Contributor
Author
|
Future updates:
|
- Rename 'Setup' page title to 'Install' - Add 'Setup a Pre-built Automation' group with placeholder sub-pages: GitHub PR Review Assistant, GitHub Repository Monitor, Slack Channel Monitor - Remove LLM Profiles and Model Configuration from nav - Add links to Skills and MCP Servers under Customize header in customize-and-settings - Remove stale llm-profiles link from Related Guides Co-authored-by: openhands <openhands@all-hands.dev>
- Convert flat backends entry to a nav group - Add placeholder sub-pages: Local, VM, Docker, OpenHands Cloud Co-authored-by: openhands <openhands@all-hands.dev>
…view - Move automations.mdx content into prebuilt-automations.mdx - Add intro section at top of prebuilt-automations linking to the three pre-built automation sub-pages (PR review, repo monitor, Slack) - Delete automations.mdx - Remove automations from Onboarding Agent Canvas nav Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
VascoSch92
reviewed
May 29, 2026
Covers all four onboarding steps with screenshots: - Step 1: Choose your agent (OpenHands, Claude Code, Codex, Gemini CLI via ACP) - Step 2: Check your backend (local default, link to backends guide) - Step 3: Set up your LLM (BYOK + OpenHands Cloud link) - Step 4: Start from a proven workflow (GitHub PR Review Copilot + pre-built automations) Co-authored-by: openhands <openhands@all-hands.dev>
* docs: add custom Agent Server image guide for Docker backend Replace the placeholder Docker backend page with a full walkthrough: build a custom Agent Server image (FROM ghcr.io/openhands/agent-server, add JDK + utilities), run it locally with a SESSION_API_KEY, and register it as a backend in Agent Canvas. Co-authored-by: openhands <openhands@all-hands.dev> * docs: use agent-server-java name, port 8001, add multi-backend section Co-authored-by: openhands <openhands@all-hands.dev> * docs: pin agent server version in FROM example Co-authored-by: openhands <openhands@all-hands.dev> * docs: use 1-python base tag with short pinning tip Co-authored-by: openhands <openhands@all-hands.dev> --------- Co-authored-by: openhands <openhands@all-hands.dev>
Drop the redundant opening paragraph. The tagline now lives in the frontmatter description field where Mintlify surfaces it. Co-authored-by: openhands <openhands@all-hands.dev>
- Clarify Customize: skills give domain knowledge, MCP servers connect to external tools/data - Clarify Settings: configure how the agent runs (LLM, secrets, etc.), not "backend-synced behavior" - Rename "Backend-Synced Behavior" to "Settings Are Per Backend" Co-authored-by: openhands <openhands@all-hands.dev>
Rename section to "Configuration Is Per Backend" and clarify that skills, MCP servers, secrets, and settings are all per-backend. Co-authored-by: openhands <openhands@all-hands.dev>
Use Cases is content about the products, not a product/interface itself. Move it into the Home tab as a sidebar group after Essential Guidelines. No redirects needed — page file paths are unchanged so URLs stay the same. Co-authored-by: openhands <openhands@all-hands.dev>
- local.mdx: auto-created backend, when to use, --public for LAN access - vm.mdx: absorb self-hosting content — full walkthrough with --public, security, nginx + Let's Encrypt, connecting remotely - cloud.mdx: connect Agent Canvas to OpenHands Cloud as a backend - Remove self-hosting.mdx, add redirect to backend-setup/vm - Update all internal links from self-hosting to backend-setup/vm Co-authored-by: openhands <openhands@all-hands.dev>
Self-hosting = deploy the full Agent Canvas stack (UI + backend) on a machine you control. Covers --public, security, nginx + TLS, and connecting from another Agent Canvas instance or --frontend-only. VM Backend = run --backend-only on a remote machine and connect from your local Agent Canvas. Focused on headless backend deployment with SSH tunnel or reverse proxy. Also adds --backend-only and --frontend-only flags to setup.mdx CLI table and documents --frontend-only in local.mdx. Co-authored-by: openhands <openhands@all-hands.dev>
…condary The primary use case is running the official ghcr.io/openhands/agent-canvas image. Custom Dockerfiles are an advanced topic, moved to a short section at the end. Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
…rise Co-authored-by: openhands <openhands@all-hands.dev>
Local backend page now focuses on: - Starting one or more backends with --backend-only on different ports - Connecting via --frontend-only and Manage Backends - Tip about running full stack without flags for simple setups Co-authored-by: openhands <openhands@all-hands.dev>
Co-authored-by: openhands <openhands@all-hands.dev>
Updated Docker and self-hosting pages to show agent-canvas --frontend-only as the way to start the UI before adding a backend via Manage Backends. Co-authored-by: openhands <openhands@all-hands.dev>
One page covers the full VM/self-hosted workflow: 1. Provision and secure the machine 2. Install prerequisites 3. Start with --backend-only --public (tip: drop --backend-only for full stack) 4. Connect from local machine with --frontend-only 5. Optional nginx + TLS for direct HTTPS access 6. Security checklist Delete self-hosting.mdx, add redirect to backend-setup/vm. Update all internal links. Co-authored-by: openhands <openhands@all-hands.dev>
rbren
approved these changes
Jun 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR reorganizes the Documentation navigation to introduce Agent Canvas as the primary onboarding path, and brings in the full Agent Canvas doc set from the
docs/agent-canvas-docsbranch.Changes
Navigation (
docs.json)Onboarding OpenHands→Onboarding Agent CanvasOnboarding Agent Canvas:Hooksout of the onboarding group and into Product Guides (after Key Features)Quick Start (
overview/quickstart.mdx)/openhands/usage/agent-canvas/setupNew pages (
openhands/usage/agent-canvas/)9 MDX files pulled from
docs/agent-canvas-docs:overview,setup,backends,llm-profiles,customize-and-settings,automations,self-hosting,development,troubleshootingThis PR was created by an AI agent (OpenHands) on behalf of the user.
@jpelletier1 can click here to continue refining the PR