Skip to content

docs: add Windows (PowerShell) instructions for Agent Canvas Docker setup#552

Merged
malhotra5 merged 1 commit into
mainfrom
add-windows-agent-canvas-docs
Jun 5, 2026
Merged

docs: add Windows (PowerShell) instructions for Agent Canvas Docker setup#552
malhotra5 merged 1 commit into
mainfrom
add-windows-agent-canvas-docs

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

Adds Windows-specific Docker commands to the Agent Canvas documentation, sourced from the upstream README.windows.md in the agent-canvas repo.

Pages updated

openhands/usage/agent-canvas/setup.mdx (Install page — Docker tab)

  • Updated Docker prerequisites to mention Docker Desktop on Windows
  • Added a "Windows (PowerShell)" section alongside the existing macOS/Linux commands
  • Includes PowerShell-syntax docker run with backtick line continuation, $env:USERPROFILE volume mount paths, and New-Item for directory creation
  • Added a <Note> explaining the PowerShell syntax differences

openhands/usage/agent-canvas/backend-setup/docker.mdx (Docker Backend page)

  • Updated prerequisites to mention Docker Desktop on macOS/Windows
  • Converted the single code block into a <Tabs> component with macOS / Linux and Windows (PowerShell) tabs
  • Windows tab includes the same PowerShell-syntax docker run command with a <Note> about Docker Desktop and backtick syntax

@malhotra5 can click here to continue refining the PR

…etup

Add Windows-specific Docker commands to both the main setup page and the
Docker backend setup page. The commands use PowerShell syntax (backtick
line continuation, $env:USERPROFILE paths, New-Item for directory creation)
matching the upstream README.windows.md from agent-canvas.

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

mintlify Bot commented Jun 4, 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 4, 2026, 4:38 PM

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

@malhotra5 malhotra5 marked this pull request as ready for review June 4, 2026 16:41
@malhotra5 malhotra5 enabled auto-merge (squash) June 4, 2026 16:44
@DevinVinson DevinVinson self-requested a review June 5, 2026 13:27
@malhotra5 malhotra5 merged commit 6982a30 into main Jun 5, 2026
5 checks passed
@malhotra5 malhotra5 deleted the add-windows-agent-canvas-docs branch June 5, 2026 13:27
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