Skip to content

docs(agent-canvas): simplify backends overview page#546

Merged
malhotra5 merged 3 commits into
mainfrom
simplify-backends-page
Jun 3, 2026
Merged

docs(agent-canvas): simplify backends overview page#546
malhotra5 merged 3 commits into
mainfrom
simplify-backends-page

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

Simplifies backends.mdx from 76 lines to 22 lines by restructuring around three focused points:

  1. What is a backend — one sentence: an agent server and its workspace
  2. Connecting to a backend — any frontend connects to any backend with authentication; settings are scoped to the active backend
  3. Recommended setups — a single table covering default local, backend-only (local/remote), and cloud options with links to detailed guides

Removes filler sections that repeated information already available on other pages (Default Local Backend, Local vs Cloud table, What Changes When You Switch Backends, Recommended Setup Pattern, Related Guides).


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

@malhotra5 can click here to continue refining the PR

Condense backends.mdx from 76 lines to 22 lines by restructuring around
three key points:

1. What is a backend (agent server + workspace)
2. Any frontend connects to any backend with authentication
3. Recommended setups table (default local, backend-only local/remote, cloud)

Removes filler sections (Default Local Backend, Local vs Cloud table,
Recommended Setup Pattern) and replaces them with a single actionable
reference table.

Co-authored-by: openhands <openhands@all-hands.dev>
@malhotra5 malhotra5 marked this pull request as ready for review June 3, 2026 15:07
@mintlify

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

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

…inology

Use 'backend' for the whole canvas stack and 'automation service' for
the specific automation component. This avoids the confusing 'backend
within a backend' naming and aligns with the terminology in backends.mdx.

Files updated:
- prebuilt-automations.mdx
- setup.mdx
- overview.mdx
- backend-setup/vm.mdx
- backend-setup/local.mdx
- backend-setup/docker.mdx

Co-authored-by: openhands <openhands@all-hands.dev>
Remove 'Local Stack Behavior' and 'Backend Availability Matters'
sections — backends already imply automation support. Replace with a
single line linking to Manage Backends.

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

@jpelletier1 jpelletier1 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.

LGTM

@malhotra5 malhotra5 merged commit e9e3823 into main Jun 3, 2026
5 checks passed
@malhotra5 malhotra5 deleted the simplify-backends-page branch June 3, 2026 15:45
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