From 19bc06620598ebce21ecae12101dee77f5099b68 Mon Sep 17 00:00:00 2001 From: openhands Date: Sat, 22 Aug 2026 21:28:06 +0000 Subject: [PATCH] docs: update documentation for OpenHands v1.15.0 - Add Getting Started checklist section to first-time-setup.mdx - Add Getting Started checklist toggle to application-settings.mdx - Add conversation overview panel, unified commits drawer, and workspace path display to conversations.mdx - Add Provider Connections section to llm-profiles.mdx - Mention provider connections in customize-and-settings.mdx LLM row - Document script bundle catalog entries and multi-repo support in prebuilt-automations.mdx Co-authored-by: openhands --- .../usage/agent-canvas/conversations.mdx | 25 +++++++++++++++++++ .../agent-canvas/customize-and-settings.mdx | 2 +- .../usage/agent-canvas/first-time-setup.mdx | 17 +++++++++++++ openhands/usage/agent-canvas/llm-profiles.mdx | 24 ++++++++++++++++++ .../agent-canvas/prebuilt-automations.mdx | 4 +++ .../usage/settings/application-settings.mdx | 4 +++ 6 files changed, 75 insertions(+), 1 deletion(-) diff --git a/openhands/usage/agent-canvas/conversations.mdx b/openhands/usage/agent-canvas/conversations.mdx index a0942420f..9537711ae 100644 --- a/openhands/usage/agent-canvas/conversations.mdx +++ b/openhands/usage/agent-canvas/conversations.mdx @@ -33,6 +33,31 @@ If a message fails to send, select `Retry` to send it again or `Dismiss` to remo When an agent creates a Markdown file, Agent Canvas renders it inline as a height-limited rich preview with an internal scrollbar instead of showing only the raw file content. Select `View` to open the full file in the Files drawer. +## Conversation Overview Panel + +The conversation overview panel displays project context for the active conversation, including workspace information, git state, and loaded resources such as skills, MCP servers, and automations. + +Toggle the overview using the info control in the conversation header. The panel peeks beside the chat area and closes when you open the Files drawer. + +### Unified Commits Drawer + +From the overview panel, open the **Commits** drawer to see a unified view of git activity: + +- The commit list shows recent commits alongside any uncommitted changes +- A header git-actions control lets you send commit, pull, push, and pull-request prompts to the agent + +The Commits tab combines the commit history with uncommitted changes in a single view, so you no longer need to switch between separate Diff and Commits surfaces. + +### Files View + +The **Files** tab is a focused file browser with open-file tabs and close controls. The file tree is resizable and persists its state across refreshes. + +Above the file tree, the active workspace path is displayed with a copy button. Hover the truncated path to see the full value in a tooltip, then click to copy it. + + + The workspace path row is hidden when the conversation has no working directory. + + ## Context Window Usage and Manual Compaction Agent Canvas shows a context-window meter in the composer that visualizes how much of the model's available context is in use. The meter fills as the conversation grows. diff --git a/openhands/usage/agent-canvas/customize-and-settings.mdx b/openhands/usage/agent-canvas/customize-and-settings.mdx index 302122550..6d624de51 100644 --- a/openhands/usage/agent-canvas/customize-and-settings.mdx +++ b/openhands/usage/agent-canvas/customize-and-settings.mdx @@ -50,7 +50,7 @@ The `Settings` area currently includes the following sections: | Section | Purpose | |---------|---------| | `Agent` | Agent Profile library and agent-specific capabilities | -| `LLM` | Provider, model, API key, and profile configuration | +| `LLM` | Provider, model, API key, profile configuration, and provider connections | | `Condenser` | Context compression and summarization behavior | | `Verification` | Approval, critic evaluation, and verification-related behavior | | `Application` | UI-level preferences and app behavior | diff --git a/openhands/usage/agent-canvas/first-time-setup.mdx b/openhands/usage/agent-canvas/first-time-setup.mdx index 151a7eafc..cc66103bf 100644 --- a/openhands/usage/agent-canvas/first-time-setup.mdx +++ b/openhands/usage/agent-canvas/first-time-setup.mdx @@ -70,6 +70,23 @@ Other available templates include: You can browse all pre-built automations from the `Automate` view at any time. See [Pre-built Automations](/openhands/usage/agent-canvas/prebuilt-automations) for the full list. +## Getting Started Checklist + +After completing the setup wizard, a **Getting Started** checklist appears in the sidebar. It guides you through the core first actions: + +1. **Set up your LLM** — links to `Settings > LLM` +2. **Connect MCP servers** — links to `Customize > MCP` +3. **Start a conversation** — links to `Conversations` +4. **Explore automations** — links to `Automate` +5. **Customize your agent** — links to `Customize` +6. **Review settings** — links to `Settings` + +Each item links directly to the relevant page. The checklist tracks your progress and minimizes to stay out of the way. When all items are complete, the checklist auto-hides. + + + Toggle the checklist from `Settings > Application` using the **Show getting started checklist** switch. The setting persists across sessions. + + ## After Your First Session Keep the terminal or Docker container that runs Agent Canvas active while you use the browser. When you are done, [stop Agent Canvas](/openhands/usage/agent-canvas/setup#stop-agent-canvas). Start it again with the same command when you return. diff --git a/openhands/usage/agent-canvas/llm-profiles.mdx b/openhands/usage/agent-canvas/llm-profiles.mdx index a5a2150ed..ce83066a1 100644 --- a/openhands/usage/agent-canvas/llm-profiles.mdx +++ b/openhands/usage/agent-canvas/llm-profiles.mdx @@ -72,6 +72,30 @@ In the **Advanced** tab, use the model name format `litellm_proxy/`, See [LiteLLM Proxy](/openhands/usage/llms/litellm-proxy) for the complete configuration. +## Provider Connections + + + Provider Connections are available on **local agent-server backends only**. The panel is hidden when using an OpenHands Cloud backend. + + +When you want multiple LLM profiles to share the same provider credentials, use **Provider Connections** to store an API key and optional base URL once and reference it across profiles. This avoids pasting the same key into every profile and lets you rotate credentials in one place. + +### Create a Provider Connection + +1. Open `Settings > LLM`. +2. In the **Provider Connections** panel, add a new connection. +3. Enter a name, the provider, the API key, and an optional base URL. + +### Link a Profile to a Provider Connection + +In the profile editor, use the **provider-connection selector** to link a profile to an existing connection. When a profile is linked, its inline API key and base URL fields are hidden — the profile uses the connection's credentials instead. + +Linked profiles are grouped under their provider connection name in the profile list for readability. + +### Broken Link Badge + +If a provider connection is deleted while still referenced by a profile, the profile shows a **Broken link** badge. Re-link the profile to another connection or restore inline credentials to resolve it. + ## Working with LLM Profiles LLM profiles are useful when you want different model setups for different tasks, such as: diff --git a/openhands/usage/agent-canvas/prebuilt-automations.mdx b/openhands/usage/agent-canvas/prebuilt-automations.mdx index 819b0571b..91ef67f80 100644 --- a/openhands/usage/agent-canvas/prebuilt-automations.mdx +++ b/openhands/usage/agent-canvas/prebuilt-automations.mdx @@ -38,6 +38,10 @@ In practice, new automation setup starts in one of two ways: For recommended automations that support a direct form setup, Agent Canvas checks the active backend's capabilities and any prerequisites, then guides you through the required input fields, a review step, and creation. If direct form setup is unavailable, it offers a conversation-assisted setup instead. Review the proposed configuration before creating an automation. +Some catalog entries ship a **script bundle** — a packaged set of files that install as a deterministic automation — rather than a prompt-based preset. Script-bundle entries run their own logic for tasks like polling, deduplication, and fixed API calls, using the agent only for the parts that genuinely require judgment. When a catalog entry supports a bundle install, the setup form handles packaging and upload automatically; you just fill in the required fields. + +Catalog entries that accept repositories can also collect multiple repositories in a single field, so one automation can monitor several repos at once. + For a detailed walkthrough, see [Creating Automations](/openhands/usage/automations/creating-automations). diff --git a/openhands/usage/settings/application-settings.mdx b/openhands/usage/settings/application-settings.mdx index 9ccadc6bf..7eb4d4478 100644 --- a/openhands/usage/settings/application-settings.mdx +++ b/openhands/usage/settings/application-settings.mdx @@ -37,6 +37,10 @@ To override the defaults: for commits and pull requests. OpenHands will remain as a co-author. +## Getting Started Checklist + +The sidebar shows a **Getting Started** checklist after first-run onboarding. Toggle `Show getting started checklist` in `Settings > Application` to hide or show it. The setting persists across sessions. See [First Time Setup](/openhands/usage/agent-canvas/first-time-setup#getting-started-checklist) for details. + ## Sandbox Grouping Strategy The `Sandbox Grouping Strategy` setting controls where OpenHands places new