Skip to content

Rewrite Agent Canvas VM installation docs#568

Merged
malhotra5 merged 1 commit into
mainfrom
docs/agent-canvas-vm-installation
Jun 12, 2026
Merged

Rewrite Agent Canvas VM installation docs#568
malhotra5 merged 1 commit into
mainfrom
docs/agent-canvas-vm-installation

Conversation

@malhotra5

Copy link
Copy Markdown
Member
  • I have read and reviewed the documentation changes to the best of my ability.
  • If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

  • Rewrites the Agent Canvas VM/self-hosted installation guide to cover backend-only and full Canvas deployments.
  • Adds Ubuntu installation commands and links to official Node.js, uv, ngrok, and ngrok authtoken documentation for OS-specific guidance.
  • Documents optional SSH tunnel, ngrok without OAuth, full Canvas with ngrok Google OAuth, tmux, and nginx/TLS reverse proxy workflows.
  • Updates related Agent Canvas links and backend setup descriptions to use the new VM / self-hosted installation framing.

Validation

  • Ran git diff --check on all changed documentation files.
  • Ran a lightweight MDX check for balanced code fences and <Tabs>/<Tab> tags.

This PR was created by an AI agent (OpenHands) on behalf of the user.

@malhotra5 can click here to continue refining the PR

Co-authored-by: openhands <openhands@all-hands.dev>
@mintlify

mintlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Jun 12, 2026, 5:22 PM

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

all-hands-bot commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Review complete.

This review was performed through OpenHands Cloud Automation. You can log in and view the conversation here.

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review: Rewrite Agent Canvas VM installation docs

Taste Rating: 🟢 Good taste - Clean, well-organized documentation rewrite.

Summary

This PR provides a comprehensive rewrite of the Agent Canvas VM/self-hosted installation guide. The changes are substantial (+228/-80) and introduce a much-needed restructure that improves clarity and coverage.

What works well:

  • The new "Choose a Deployment Shape" table gives users a clear decision framework upfront
  • Tabs effectively differentiate between backend-only and full Canvas deployment paths
  • The security checklist is appropriately expanded for remote deployments
  • Access method options (SSH tunnel, ngrok, reverse proxy) are clearly documented
  • Cross-references across all affected files are consistently updated

No Blocking Issues Found

The documentation is technically sound, well-organized, and covers the key deployment scenarios users would encounter. The rewrite clearly explains the difference between backend-only and full Canvas modes, which was a gap in the previous version.

[RISK ASSESSMENT]

  • [Overall PR] ⚠️ Risk Assessment: 🟢 LOW

This is a documentation-only change with no code, dependency, or configuration modifications. The risk is negligible — any rendering or linking issues would be caught during the normal documentation build process.

VERDICT:Worth merging

The rewritten documentation provides significantly better guidance for users setting up Agent Canvas on VMs. No changes required.


This review was generated by an AI agent (OpenHands) on behalf of the user through OpenHands Automation. View conversation

@malhotra5 malhotra5 merged commit 586358d into main Jun 12, 2026
5 checks passed
@malhotra5 malhotra5 deleted the docs/agent-canvas-vm-installation branch June 12, 2026 19:54
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