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

automation: Docs update for OpenHands v1.21.0 release

Closed
  • Is something wrong?
#822 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
Domain
documentation

Research direction

Start with the release checklist and review the mentioned docs: canvas-extensions.mdx, docker-execution.mdx, conversations.mdx, and environment-variables.mdx. Compare each confirmed user-facing change with its current documentation, especially the full browser tree URL support for app installation. Done means updating only confirmed documentation gaps and verifying the affected pages remain accurate.

Written by the indexing model from the issue text.

Description

ready-for-human

Release

Release summary

OpenHands v1.21.0 contains one feature, seven bug fixes, two documentation changes to the OpenHands repository's own contributor docs, and eight maintenance items. The feature teaches the Agent Canvas client to read the agent server's advertised execution_runtime from /server_info and explicitly request a DockerExecutionWorkspace when Docker execution is available, keeping LocalWorkspace as the default for local and older servers. The fixes address stale conversation-history merges, routing Forgejo PR/issue lists to the Forgejo host, accepting git-host folder/tree URLs as an app source, disabling PostHog autocapture, keeping the local static server serving current assets after a Canvas rebuild, presenting non-resumable local conversations as archived, and advertising host services to Docker conversations. Maintenance bumps the default runtime versions twice (SDK/Agent Server/TypeScript client 1.49.2 then 1.49.3; Automation 1.13.2 then 1.13.3) and adds or strengthens several test suites. @Harsh23Kashyap is credited as a new contributor.

Documentation review checklist

  • feat: request Docker execution workspaces from Docker servers (PR #17177) — needs maintainer confirmation. The agent-server adapter now reads execution_runtime from /server_info and explicitly requests DockerExecutionWorkspace when a Docker server advertises Docker execution, preserving LocalWorkspace as the default for local/older servers. The Docker-execution docs page (/openhands/usage/agent-canvas/backend-setup/docker-execution) already states that Agent Server creates a DockerExecutionWorkspace per conversation, so it is unclear whether the client-side request changes any documented operator procedure. Source: https://github.com/OpenHands/OpenHands/pull/17177
  • fix: prevent stale conversation history merges (PR #16913) — probably no documentation change. Discards stale older-events responses using a per-load marker and event-store ownership check so a request started in one conversation cannot merge into another after navigation. Internal correctness fix to conversation history loading; no documented procedure changed. Source: https://github.com/OpenHands/OpenHands/pull/16913
  • fix: query the Forgejo host for Forgejo PR and issue lists (PR #17486) — needs maintainer confirmation. listPullRequests/listIssues previously routed Forgejo requests through fetchGithubJson (hardcoded api.github.com), so a Forgejo-backed conversation's overview panel showed an error or another repository's items. The fix adds a Gitea-style fetch against {baseUrl}/api/v1 authenticated with Authorization: token <FORGEJO_TOKEN>. Forgejo is only mentioned in environment-variables.mdx for the ALLOW_INSECURE_GIT_ACCESS variable; triage whether git-provider docs describe the overview PR/issue panel for Forgejo. Source: https://github.com/OpenHands/OpenHands/pull/17486
  • fix(apps): accept GitHub tree URLs as app source (PR #17504) — documentation needed. Pasting a git host's browser folder/tree URL (GitHub, GitLab, Bitbucket, Gitea/Forgejo) into Customize → Apps → Add app → App source now installs the app; the modal splits the URL into source, ref, and repo_path before calling POST /api/canvas-extensions/install. The Canvas Extensions "Install an App" section (/openhands/usage/agent-canvas/canvas-extensions) documents entering a Git source such as github:owner/repository and a separate Repo path, but does not mention that a full browser tree URL is accepted. Source: https://github.com/OpenHands/OpenHands/pull/17504
  • fix: Disable PostHog autocapture (PR #17502) — probably no documentation change. Sets autocapture: false in the named agent-canvas PostHog init config (src/services/telemetry.ts). Telemetry/analytics consent behavior is not documented on a user-facing page (the only related docs are historical release notes). Note for reviewer: this reduces client-side click telemetry; consider whether any analytics/consent docs should mention it. Source: https://github.com/OpenHands/OpenHands/pull/17502
  • fix(static-server): serve current assets after rebuilding Canvas (PR #17402) — probably no documentation change. Switches the local static server to filesystem lookup mode so a rebuild's hashed assets are served instead of the stale startup inventory. Internal local-development tooling fix; no documented procedure changed. Source: https://github.com/OpenHands/OpenHands/pull/17402
  • fix: show non-resumable local conversations as archived (PR #17500) — needs maintainer confirmation. After an installation switches from host-local conversation runtimes to Docker runtimes, historical local conversations have no Docker provisioning identity; Canvas now presents them using the existing archived-conversation UI, skips WebSocket connections, and continues loading persisted event history over REST. Depends on agent-sdk #5128. The conversations.mdx archive section describes archiving as a user action stored per backend; triage whether the runtime-switch archiving behavior warrants a note. Source: https://github.com/OpenHands/OpenHands/pull/17500
  • fix: advertise host services to Docker conversations (PR #17518) — probably no documentation change. Changes the local dev launcher (scripts/dev-with-automation.mjs) to advertise host services through host.docker.internal and route Automation traffic through the Canvas ingress in Docker mode. Affects a developer script, not a documented user procedure. Source: https://github.com/OpenHands/OpenHands/pull/17518
  • docs: refresh AGENTS.md guidance (PR #17590) — probably no documentation change. Documentation-only correction to AGENTS.md in the OpenHands repository (an internal contributor guide), not user-facing product documentation in OpenHands/docs. Source: https://github.com/OpenHands/OpenHands/pull/17590
  • docs(codereview): clarify Agent Canvas checkpoints (PR #17523) — probably no documentation change. Reorganizes .agents/skills/custom-codereview-guide.md and AGENTS.md in the OpenHands repository (internal reviewer guidance), not user-facing product documentation. Source: https://github.com/OpenHands/OpenHands/pull/17523
  • chore: consume SDK 1.49.2 and Automation 1.13.2 (PR #17515) — needs maintainer confirmation. Bumps default runtime version pins in config/defaults.json, package.json, and related scripts. If docs reference specific default runtime versions or compatibility minimums, they may need updating; the current docs version references found are release-notes text. Source: https://github.com/OpenHands/OpenHands/pull/17515
  • chore: consume SDK 1.49.3 and Automation 1.13.3 (PR #17600) — needs maintainer confirmation. Second default-runtime bump within this release (supersedes the 1.49.2/1.13.2 pin from #17515). Confirm the intended final defaults against the release's config/defaults.json before documenting any version. Source: https://github.com/OpenHands/OpenHands/pull/17600
  • test: cover draft persistence (PR #17334) — probably no documentation change. Test-only change (__tests__/hooks/use-draft-persistence.test.tsx). Source: https://github.com/OpenHands/OpenHands/pull/17334
  • test: strengthen LLM profile configuration (PR #17338) — probably no documentation change. Test-only change. Source: https://github.com/OpenHands/OpenHands/pull/17338
  • test: strengthen shared utility behavior (PR #17341) — probably no documentation change. Test-only change. Source: https://github.com/OpenHands/OpenHands/pull/17341
  • test: cover MCP config utilities (PR #17344) — probably no documentation change. Test-only change. Source: https://github.com/OpenHands/OpenHands/pull/17344
  • chore: remove merged PR artifacts (PR #17507) — probably no documentation change. Housekeeping of PR-only image artifacts; no file changes. Source: https://github.com/OpenHands/OpenHands/pull/17507
  • refactor(shadcn-lint): map --oh-* tokens into the Tailwind theme (PR #17435) — probably no documentation change. Internal linting/theming refactor across many Canvas components; no documented behavior or configuration change identified. Source: https://github.com/OpenHands/OpenHands/pull/17435

Pull request review

Human testing required

  • Docker execution workspace request (PR #17177): Point Canvas at an agent server whose /server_info advertises Docker execution and start a new conversation. Expected: the conversation runs in a DockerExecutionWorkspace with /workspace as its working directory. Then point Canvas at a local or older server and expected: LocalWorkspace remains the default.
  • Forgejo PR/issue lists (PR #17486): With a Forgejo-backed repository and FORGEJO_TOKEN configured, open a Forgejo conversation's overview panel. Expected: it lists that repository's PRs and issues fetched from the Forgejo host (no error state, and no same-named GitHub repository's items). A control case is a GitHub/GitLab repo, whose behavior should be unchanged.
  • Git tree URL as app source (PR #17504): Paste a git host's browser folder URL (e.g. https://github.com/OpenHands/canvas-apps/tree/main/conversation-search-sidecar) into Customize → Apps → Add app → App source. Expected: install succeeds, splitting the URL into source/ref/repo_path. Repeat for GitLab, Bitbucket, and Gitea/Forgejo folder URLs.
  • Archived non-resumable local conversations (PR #17500): After switching an installation to Docker runtime, open a conversation created before Docker provisioning metadata existed. Expected: it is presented as archived, its persisted event history is readable over REST, and no WebSocket connection is attempted.
  • Runtime default versions (PR #17515, PR #17600): Confirm the intended default Agent Server/SDK/TypeScript client and Automation versions against the release's config/defaults.json, and check whether any published docs page references specific default runtime versions that now need updating.

Suggested documentation locations

  • /openhands/usage/agent-canvas/release-notes/ — Add a new v1.21.0.mdx page following the existing format (see v1.20.0.mdx) and add the matching entry to the Agent Canvas release-notes group in docs.json. Rationale: this version has no release-notes page, unlike every prior release.
  • /openhands/usage/agent-canvas/canvas-extensions.mdx (Install an App) — Note that a git host's browser folder/tree URL is accepted as the App source, in addition to the github:owner/repository shorthand and Repo path. Rationale: PR #17504 changes that user-facing install flow.
  • /openhands/usage/agent-canvas/backend-setup/docker-execution.mdx — Verify whether the client-side request of DockerExecutionWorkspace from Docker servers needs documentation. Rationale: PR #17177 changes how Canvas selects the execution workspace.
  • /openhands/usage/agent-canvas/conversations.mdx (archive section) — Consider noting that non-resumable local conversations appear archived after a runtime switch. Rationale: PR #17500.
  • /openhands/usage/environment-variables.mdx or a git-provider page — Triage Forgejo PR/issue list behavior (PR #17486) and any default-runtime version references (PR #17515, PR #17600). Needs maintainer triage for the exact location.

Source links

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

Dominant language
MDX
Stars
14
Forks
61
Avg merge
2d 4h
Merged PRs (30d)
58

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.