Skip to content

Updates to New User flows from user feedback#607

Merged
enyst merged 7 commits into
mainfrom
agent-canvas-docs-onboarding-updates
Jul 9, 2026
Merged

Updates to New User flows from user feedback#607
enyst merged 7 commits into
mainfrom
agent-canvas-docs-onboarding-updates

Conversation

@DevinVinson

@DevinVinson DevinVinson commented Jul 6, 2026

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

Updates the Agent Canvas docs to better support first-time setup and troubleshooting based on recent user interview feedback and docs-chat query analysis.

Changes include:

  • Clarifies the Agent Canvas overview around the core mental model: UI, backend, workspace, agent/model, trust boundary, and setup path.
  • Expands the install page into a lifecycle guide covering npx, global npm install, Docker, source setup, prerequisites, startup confirmation, stop/update/uninstall, and common flags.
  • Expands troubleshooting coverage for high-frequency setup issues, including command/PATH problems, missing uv, browser startup issues, port conflicts, Docker daemon errors, backend URL/API key confusion, model/provider errors, ACP credentials, workspace location, MCP settings, automations, and uninstall/update problems.

Pages changed:

Context

Recent user interviews showed that Agent Canvas is valuable once running, but users often need more support understanding where the agent runs, what files it can access, how model credentials work, and which setup path to choose.

Docs-chat analysis also showed increased Agent Canvas, install/setup, uninstall, backend, and model configuration questions, with “Canvas vs core concepts” being a high-volume area where users were less consistently getting useful answers.

These docs changes make the onboarding path more explicit and give users concrete recovery steps when setup does not work on the first try.

Rework the overview page around the first-run mental model users need before setup: when to use Agent Canvas, how the UI/backend/workspace/model pieces fit together, which trust boundary to choose, and where to go next. This addresses interview and docs-chat feedback showing confusion around Agent Canvas setup paths, backend execution, model access, and file access.
Rework the setup page from a short install reference into a full lifecycle guide. The page now helps users choose npm, Docker, VM/self-hosted, or source workflows; verify prerequisites; start and confirm the local UI; understand common flags and environment variables; and stop, update, or uninstall Agent Canvas. This targets setup and uninstall confusion surfaced in interview feedback and docs-chat analysis.
@DevinVinson

Copy link
Copy Markdown
Member Author

@jpelletier1 This makes some major changes to the entry point for agent canvas. Take a look when you get a chance and let me know any feedback:
agent-canvas > overview - Preview Link
agent-canvas > install - Preview Link

@mintlify

mintlify Bot commented Jul 6, 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 Jul 6, 2026, 4:10 PM

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

Comment thread openhands/usage/agent-canvas/overview.mdx Outdated
Comment thread openhands/usage/agent-canvas/overview.mdx Outdated
Comment thread openhands/usage/agent-canvas/setup.mdx Outdated
DevinVinson and others added 2 commits July 9, 2026 17:16
Co-authored-by: Engel Nyst <engel.nyst@gmail.com>
Co-authored-by: Engel Nyst <engel.nyst@gmail.com>
Co-authored-by: Engel Nyst <engel.nyst@gmail.com>

@enyst enyst left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for this! Let’s try, and we can always continue to iterate.

@jpelletier1

Copy link
Copy Markdown
Contributor

@DevinVinson LGTM!

@enyst enyst merged commit 836ba7f into main Jul 9, 2026
5 checks passed
@enyst enyst deleted the agent-canvas-docs-onboarding-updates branch July 9, 2026 23:16
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