OpenHands / OpenHands/docs

automation: Agent Canvas documentation image requests — 2026-08-24

Open
#752 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

ready-for-human
Dominant language
MDX
Stars
12
Forks
52
Avg merge
1d 6h
Merged PRs (30d)
32

Description

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

Audit record

Source SHAs
  • OpenHands/OpenHands: 46e44c10d3eb462c1868fcf23b51ae4e75295f48
  • OpenHands/docs: 2a6b199bf9dd1978f87f69a4356acbe85adfba03
Pages reviewed

All 28 pages listed in the Agent Canvas tab of docs.json: overview, architecture, installation and backend setup, automations and prebuilt automations, conversations, profiles, ACP agents, plugins, Critic, settings, mobile access, development, and troubleshooting.

Reviewed in-scope prose and image references, relevant openhands/static/img assets, recent page and asset history, current Agent Canvas source, and mock-LLM E2E journeys. Open and closed issues and open/draft PRs were searched for the exact queue-title prefix and overlapping requests, including a final check before creation.

Safety and scope

Agent Canvas is read-only; OpenHands/docs is the sole write target. Capture data must be synthetic. No secrets, personal data, real local paths, private URLs, or real conversation content may be captured. Use the OpenHands-Neutral theme.

Requested image

  1. Add — conversation overview panel
    • Target page / exact prose anchor: openhands/usage/agent-canvas/conversations.mdx, ## Conversation Overview Panel, immediately after: “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.” Add.
    • Intended filename / descriptive alt text: agent-canvas-conversation-overview-panel.png; “Agent Canvas conversation overview panel showing a synthetic workspace and Git repository context beside a conversation.”
    • Material reader benefit: The prose requires readers to find an unobvious header control and distinguish the overview panel from the Files drawer and the nested Commits drawer. A focused capture makes the panel location, workspace context, and Git context immediately recognizable; this is a state-recognition and control-location need, not decorative UI.
    • Exact UI state: A local mock-LLM conversation with the conversation overview open from the info control. Show the panel’s workspace row and Git repository row; keep the chat itself visually minimal and do not open the Files drawer or Commits drawer.
    • Synthetic records / data: Workspace display demo-project; Git repository demo-org/demo-repo; a single neutral mock-LLM assistant response such as Demo task complete. No API keys, tokens, real user names, repository data, full workspace paths, or real conversation content.
    • Route / navigation steps: Start the existing mock-LLM E2E environment; use the profile setup path; create a synthetic conversation; attach synthetic workspace metadata; configure the synthetic Git remote; navigate to /conversations/<synthetic-id>; select the conversation-overview-toggle.
    • Likely reusable E2E spec / helper: tests/e2e/mock-llm/files/mock-llm-files-and-git.spec.ts, especially the “conversation overview shows workspace / git identity” journey, seedWorkspaceMetadata, conversation-overview-toggle, conversation-overview-panel, conversation-overview-workspace, and conversation-overview-git-repo. Replace its test-only /tmp/e2e-test-project/my-app display with the synthetic, non-path label specified above before capturing.
    • Crop / context guidance: Include the conversation header with the activated info control, the overview panel, and a narrow, de-identified edge of the conversation surface to establish placement. Exclude browser chrome, sidebars, terminal output, file tree, developer tools, full local paths, and the Commits drawer. Keep workspace and Git labels legible at documentation width.
    • Theme requirement: OpenHands-Neutral.
    • Safety / privacy checks: Confirm that all visible text uses the stated synthetic values; no credential fields, keys, personal data, real paths, private URLs, repository content, or real conversation material appear. Do not capture any external or third-party UI.
    • Acceptance criteria: The image visibly shows the conversation-header overview control, the open overview panel, a synthetic workspace context, and a synthetic Git repository context; it distinguishes this panel from Files and Commits surfaces; it matches the current UI and remains legible at page width.
    • Priority / confidence: P1 / High.

Rejected or deferred candidates

  • Backend connection form and saved LLM profile manager: rejected as already covered by the closed prior queue issue #731 and by accurate existing assets.
  • First-time setup and automation import preview: rejected because all wizard steps and the import preview already have accurate screenshots.
  • Critic settings and results: rejected because dedicated images already cover both material states.
  • Provider Connections: deferred because open PR #717 documents the new feature; avoid duplicating an active documentation effort.
  • Conversation branching and plugin attachment: deferred because no dedicated mock-LLM E2E journey establishes a capture-ready, synthetic state without introducing capture-only setup.
  • Prebuilt GitHub and Slack workflows: rejected because representative states require credentials or third-party UI.
  • Architecture, install, self-hosting, and troubleshooting: rejected because diagrams, code, or terminal output communicate the information better than an Agent Canvas screenshot.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Update openhands/usage/agent-canvas/conversations.mdx after the Conversation Overview Panel anchor. Start with tests/e2e/mock-llm/files/mock-llm-files-and-git.spec.ts and its workspace/Git overview journey, using the named synthetic values and OpenHands-Neutral theme. Done means adding the requested legible image with the overview control, panel, workspace, and repository context while excluding Files, Commits, paths, credentials, and real data.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
70/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.