Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

automation: Docs update for OpenHands v1.25.0 release

Open
  • Is something wrong?
#903 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
markdown
Domain
documentation

Research direction

Start with the suggested documentation locations in the issue, including openhands/usage/agent-canvas/model-configuration.mdx, and review the linked release PRs for the user-facing behavior. Identify which checklist items need user documentation and match them to the existing docs structure. Done means the warranted v1.25.0 changes are documented accurately and the checklist’s uncertain items are resolved with maintainers.

Written by the indexing model from the issue text.

Description

ready-for-human

Release

Release summary

OpenHands v1.25.0 (Agent Canvas) ships a large batch of settings and agent-profile features: Model Router settings with an optional "Run at conversation start" toggle (and renamed built-in routers, OpenHands Router Pro / Flash), bulk-add of provider models as LLM profiles (global and per-connection), per-profile persona / extra instructions, server-driven tool selection for agent profiles, an Update action for installed Canvas Apps, manifest-declared SVG icons for Canvas Apps, optional voice dictation in the chat input, configurable workspace file discovery in the Files panel, and automations-dashboard improvements (filter by creator, templates on cloud backends, native git integrations). It also carries many frontend fixes, maintenance bumps (agent-server / SDK 1.53.0, Extensions, Automation), and repository-only docs/CI changes.

Documentation review checklist

  • Model Router settings — documentation needed: a user-facing settings surface for creating/editing/activating model routers, with a "Run at conversation start" toggle (off by default; auto-enabled when the first router is created). No current Agent Canvas docs page covers Model Router. Sources: #16147, #17797, #17840, #17835, #18020, #17860
  • Default routers renamed to OpenHands Router Pro / Flash — documentation needed: user-visible template names and identifiers changed (openhands-router-pro, openhands-router-flash). Source: #17782
  • Bulk-add provider models as LLM profiles — documentation needed: adds an "Add models" flow that creates multiple LLM profiles at once, both globally and per provider connection; linked profiles inherit the connection's credentials. Sources: #16426, #17723
  • Agent profile persona / extra instructions — documentation needed: the Agent Profile editor gains a System prompt section (keep default, add instructions, or custom persona); persona replaces who the agent is while security/risk/memory/tool guidance stays. Sources: #17843, #17516
  • Voice dictation in the chat input — documentation needed: optional mic button (frontend-only, settings stored in the browser) that uploads audio to a transcription endpoint. Source: #17804
  • Workspace file discovery settings — documentation needed: the local Files panel gains per-workspace discovery settings (exclusions, include file symlinks, remove file-count cap); a finite limit shows when the tree is truncated. Source: #17869
  • Update action for installed Canvas Apps — documentation needed: Apps installed from a local path or Git can be updated in place without uninstall/reinstall; a failed copy keeps the old version working. Source: #17736
  • Canvas App manifest SVG icon — documentation needed: Canvas Apps can declare manifest.icon; the client fetches GET /api/canvas-extensions/installed/{name}/icon and renders it in the sidebar/card. Source: #17877
  • Automations dashboard filter by creator — documentation needed (cloud): an Anyone / Me / Others filter on the Automations dashboard; server-side filtering. Source: #17814
  • Automations templates on cloud backends and native git integrations — documentation needed (cloud): Automation Templates now show on cloud backends; the built-in git integration is offered before issue-to-PR templates. Sources: #17830, #17868
  • Automations list offset paging / Load more past 100 — probably no documentation change: internal paging fix. Source: #17839
  • Hide agent profiles for preset automation actions — probably no documentation change: setup-dialog correctness fix. Source: #17971
  • Title generation uses the running agent profile's LLM — probably no documentation change: behavior fix. Source: #16886
  • Preserve saved prompt suffix for inline/profile launches — probably no documentation change: behavior fix. Source: #17719
  • Onboarding: preserve canonical LLM settings; show progress while starting a chat — probably no documentation change: onboarding correctness fixes. Sources: #17211, #17212
  • Canvas scoped runtime clients / workspace capabilities — needs maintainer confirmation: affects Docker/isolated backends; may warrant a note in the Docker sandbox docs. Source: #17387
  • WebSocket reconnect on foreground / mobile background — needs maintainer confirmation: behavior change that may affect the phone/tablet access page. Source: #17982
  • Settings sub-page accessibility, viewport, and composer fixes (#17587, #18008, #18012, #18013, #18015, #18011, #18014, #18016, #18017, #18009) — probably no documentation change: incremental UI/accessibility fixes.
  • Maintenance: agent-server/SDK pinned to 1.53.0, Extensions and Automation bumps, dependency updates, Node runtime pins — probably no documentation change unless a version-support page needs the new minimum agent-server.

Pull request review

  • #16147 — Adds the Model Router settings surface (/settings/meta-llm); user-facing, no docs coverage.
  • #17797 — Adds the Model Router "Run at conversation start" toggle (off by default, persisted via settings API).
  • #17840 — Auto-enables that toggle when the first router is created.
  • #17835 — Preselects the router classifier model when no LLM profiles exist.
  • #18020 — Keeps "Don't create profiles" for router templates.
  • #17860 — Completes the Router Flash template prompt and injects the model table.
  • #17782 — Renames the built-in routers to OpenHands Router Pro / Flash.
  • #16426 — Bulk-adds provider models as LLM profiles.
  • #17723 — Redesigns bulk-add around a provider picker with optional provider-connection binding.
  • #17843 — Adds the Agent Profile System prompt section (persona / extra instructions).
  • #17516 — Server-driven tool selection for profiles; pins agent-server 1.53.0.
  • #17804 — Adds optional voice dictation to the chat input.
  • #17869 — Adds workspace file discovery settings to the Files panel.
  • #17736 — Adds an Update action for installed Canvas Apps.
  • #17877 — Renders a Canvas App's manifest-declared SVG icon.
  • #17814 — Adds an Automations dashboard "Filter by creator" field.
  • #17830 — Shows Automation Templates on cloud backends and offers native git integrations.
  • #17868 — Offers the built-in integration before issue-to-PR templates.
  • #17387 — Consumes scoped runtime clients and workspace capability flags (Docker/isolated backends).
  • #17982 — Reconnects the conversation WebSocket on foreground, disconnects on mobile background.
  • #17866 — Blocks hidden Canvas settings pages when locked to a Cloud host.
  • #17984 — Backs off refetch-on-focus bursts that trip cloud rate limits.
  • #17825 — Removes the unreachable non-embedded agent-settings mode.
  • #17638, #17726, #17267, #16316, #17990 — Repository review-guidance docs; no user-facing docs impact.
  • #17769, #16884 — Changes to the OpenHands app repository's own README/DEVELOPMENT docs; not the docs site.
  • #17750, dependency bumps, and Node runtime pins — maintenance only; no user-facing docs impact.
  • #17842, #16976 — Internal linking and analytics handoff fixes; no docs impact found.

Human testing required

  • Model Router: create a router, confirm "Run at conversation start" defaults to off, create the first router and confirm the toggle auto-enables, then reload — expected: toggle state persists via the settings API and routing runs at conversation start when enabled.
  • Bulk-add LLM profiles: from Settings > LLM, bulk-add provider models with and without a bound provider connection — expected: linked profiles inherit the connection credentials and keyless profiles are created when no connection is selected.
  • Agent profile persona: set a custom persona and send a message — expected: the System Message shows the persona followed by the retained security/risk/memory/tool guidance.
  • Voice dictation: enable the mic on a supported browser and dictate — expected: audio is uploaded to the configured transcription endpoint and the transcript lands in the composer.
  • Workspace file discovery: open a large workspace, change exclusions and toggle file symlinks — expected: the tree reflects the settings and a finite limit is shown when the tree is truncated.
  • Canvas App Update: install a local-path App, edit the bundle without bumping the version, and Update — expected: the page picks up the change; a broken entrypoint shows an error and keeps the old version working.
  • Automations filter by creator: open the Automations dashboard and filter by Anyone / Me / Others — expected: server-side filtering returns the matching automations beyond the first page.

Suggested documentation locations

  • openhands/usage/agent-canvas/model-configuration.mdx — natural home for Model Router settings, or a new dedicated Agent Canvas page if maintainers prefer.
  • openhands/usage/agent-canvas/llm-profiles.mdx — bulk-add provider models and per-connection linking.
  • openhands/usage/agent-canvas/agent-profiles.mdx — profile persona / extra instructions and server-driven tool selection.
  • openhands/usage/agent-canvas/canvas-extensions.mdx — Canvas App Update action and manifest-declared SVG icon.
  • openhands/usage/agent-canvas/conversations.mdx or a new page — voice dictation in the chat input.
  • openhands/usage/agent-canvas/conversations.mdx (Files panel) — workspace file discovery settings.
  • openhands/usage/automations/ (overview.mdx / managing-automations.mdx) — creator filter, templates on cloud backends, native git integrations.
  • openhands/usage/agent-canvas/release-notes/ — add a v1.25.0 release-notes page and link it from the Release Notes group in docs.json.
  • openhands/usage/agent-canvas/mobile-access.mdx / Docker sandbox pages — maintainer triage for WebSocket mobile behavior and scoped runtime clients.

Source links

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

Dominant language
MDX
Stars
16
Forks
63
Avg merge
2d 3h
Merged PRs (30d)
59

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from OpenHands/docs

All issues in OpenHands/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.