docs: adopt a consistent convention for OpenHands Enterprise differences in the Agent Canvas docs

Đang mở
#1,125 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
48/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown
Lĩnh vực
documentation

Hướng nghiên cứu

Start with .agents/skills/docs-writing/SKILL.md and the ownership guidance in AGENTS.md, then verify each candidate passage against the source repositories before editing. Review the listed Agent Canvas pages, keeping the default behavior separate from backend-specific caveats and naming local, OpenHands Cloud, and self-hosted OpenHands Enterprise precisely. Done means the convention is documented, the selected passages meet the acceptance criteria, and mint broken-links passes.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Problem

The Agent Canvas docs describe behavior for three different backends (local, OpenHands Cloud, and self-hosted OpenHands Enterprise), but there is no convention for marking which sentences apply to which. Today the pages under openhands/usage/agent-canvas/ use about seven different shapes for the same kind of Enterprise caveat, and most of them don't tell the reader what the other backends do. A reader on a local backend can't tell whether a paragraph applies to them.

This surfaced while consolidating the v1.36.0-v1.39.0 release docs (#1124). The v1.38.0 draft overwrote the paragraph in agent-profiles.mdx that explained how profile selection works by default, leaving only the self-hosted Enterprise exception, and it pulled a universal rule ("you cannot switch profiles mid-conversation") into the Enterprise sentence so it read as Enterprise-only. That was fixed in f92e00ed on #1124, but nothing stops the next release draft from doing the same thing, because the rule isn't written down.

Shapes currently in use

Shape Example
Inline, condition first, states what other backends do openhands/usage/agent-canvas/customize-and-settings.mdx:28
Inline, Cloud and Enterprise lumped together openhands/usage/agent-canvas/llm-profiles.mdx:150
## section openhands/usage/agent-canvas/overview.mdx:58
### subsection openhands/usage/agent-canvas/agent-profiles.mdx:63
<Note> openhands/usage/agent-canvas/first-time-setup.mdx:93, openhands/usage/agent-canvas/agent-profiles.mdx:11
<Tabs> openhands/usage/agent-canvas/automation-events.mdx:229
## on a sub-page openhands/usage/agent-canvas/prebuilt/github-pr-review.mdx:56

customize-and-settings.mdx:28 is the best existing model. It leads with the condition and closes with "Other deployments keep the in-app MCP Servers page." That closing clause is what the others are missing.

Proposed convention

Pick the shape by the size of the difference:

  • A one-sentence caveat: inline text, condition first, and say what the other backends do.
  • A control that only exists on Enterprise, or works substantially differently there: its own ###, titled <Feature> on OpenHands Enterprise.
  • Parallel instructions per deployment: <Tabs>, as automation-events.mdx:229 already does.
  • <Note> or <Warning>: only when the reader would otherwise get it wrong. The existing "Limit caveats and callouts" rule in .agents/skills/docs-writing/SKILL.md still applies.

Two rules regardless of shape:

  1. Document the default behavior first. An Enterprise caveat adds to the baseline explanation; it never replaces or absorbs it. Keep behavior that applies to every backend out of the Enterprise-specific text.
  2. Name the backend precisely. Distinguish self-hosted Enterprise from OpenHands Cloud from a local backend. "Enterprise" alone is ambiguous when Canvas talks to all three. Name the admin control that flips the behavior (for example Enable Agent Profiles in the Admin Console) and link to the page under enterprise/ that documents it.

Suggested work

  1. Add the convention to .agents/skills/docs-writing/SKILL.md as a new section, so agents editing these pages follow it. Consider a line in AGENTS.md under "Docs writing conventions" pointing at it.
  2. Retrofit the inconsistent spots. Candidates, in rough priority order:
    • llm-profiles.mdx:150 — lumps Cloud and Enterprise together; confirm whether the behavior really is identical on both, and say what local backends do.
    • first-time-setup.mdx:93 — <Note> whose Enterprise clause ("On Cloud and Enterprise environments no checklist will be shown") would read better inline.
    • overview.mdx:58 — "Enterprise License Warnings" as a top-level ## in an otherwise backend-neutral overview page; consider whether it belongs here, under enterprise/, or as a ###.
    • agent-profiles.mdx:11 — <Note> covering the default profile rules; check it against the convention.
    • managing-automations.mdx:146 — says "On a cloud backend"; verify that covers both Cloud and self-hosted Enterprise, and that local backends are addressed.
    • prebuilt/github-pr-review.mdx:56 — section title says "Enterprise" but the body says "self-hosted (OpenHands Enterprise)"; pick one phrasing.
  3. Leave architecture.mdx, backends.mdx, and the backend-setup/ pages alone. Those compare deployments as their actual subject, so a table or dedicated section is correct there.

Acceptance criteria

  • The convention is written down in .agents/skills/docs-writing/SKILL.md.
  • Each retrofitted passage names the specific backend, states what the other backends do, and does not leave backend-neutral behavior inside an Enterprise-only paragraph.
  • mint broken-links passes.

Notes for whoever picks this up

Verify behavior against the source repos before rewording, rather than preserving the existing phrasing. Several of these passages describe capability-gated or admin-gated behavior, and the gate's effect on other backends is often the undocumented part. AGENTS.md lists which repository owns which behavior.

Ngôn ngữ chính
MDX
Star
19
Fork
104
Merge trung bình
2 ngày 12 giờ
Pull request đã merge (30 ngày)
80

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của OpenHands/docs

Tất cả issue của OpenHands/docs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.