Skip to content

🙌 OpenHands: AI-Driven Development

Add images and example commands to cloud issue resolver documentation (#8785)

Graham Neubigd770edc010b1
diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
index 7053819166..9a10f097f3 100644
--- a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
+++ b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
@@ -8,18 +8,30 @@ Le Résolveur de Problèmes Cloud est disponible automatiquement lorsque vous ac
- [Accès au dépôt GitHub](./github-installation#adding-repository-access)
- [Accès au dépôt GitLab](./gitlab-installation#adding-repository-access)
+![Ajout d'accès au dépôt à OpenHands](/img/cloud/add-repo.png)
+
## Utilisation
Après avoir accordé l'accès au dépôt OpenHands Cloud, vous pouvez utiliser le Résolveur de Problèmes Cloud sur les problèmes et les pull/merge requests dans vos dépôts.
### Travailler avec les Problèmes
-Sur votre dépôt, étiquetez un problème avec `openhands`. OpenHands va :
+Sur votre dépôt, étiquetez un problème avec `openhands` ou ajoutez un message commençant par `@openhands`. OpenHands va :
1. Commenter le problème pour vous faire savoir qu'il y travaille
- Vous pouvez cliquer sur le lien pour suivre la progression sur OpenHands Cloud
2. Ouvrir une pull request (GitHub) ou une merge request (GitLab) s'il détermine que le problème a été résolu avec succès
3. Commenter le problème avec un résumé des tâches effectuées et un lien vers la PR/MR
+![Résolveur de problèmes OpenHands en action](/img/cloud/issue-resolver.png)
+
+#### Exemples de Commandes pour les Problèmes
+
+Voici quelques exemples de commandes que vous pouvez utiliser avec le résolveur de problèmes :
+
+```
+@openhands lisez la description du problème et corrigez-le
+```
+
### Travailler avec les Pull/Merge Requests
Pour qu'OpenHands travaille sur les pull requests (GitHub) ou les merge requests (GitLab), mentionnez `@openhands` dans les commentaires pour :
@@ -30,3 +42,15 @@ Pour qu'OpenHands travaille sur les pull requests (GitHub) ou les merge requests
OpenHands va :
1. Commenter pour vous faire savoir qu'il y travaille
2. Effectuer la tâche demandée
+
+#### Exemples de Commandes pour les Pull/Merge Requests
+
+Voici quelques exemples de commandes que vous pouvez utiliser avec les pull/merge requests :
+
+```
+@openhands reflétez les commentaires de la revue
+```
+
+```
+@openhands corrigez les conflits de fusion et assurez-vous que le CI passe
+```
diff --git a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
index b7db34ad94..222102e992 100644
--- a/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
+++ b/docs/i18n/fr/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
@@ -36,6 +36,8 @@ Vous pouvez accorder à OpenHands l'accès à des dépôts spécifiques :
- Permissions GitHub de l'utilisateur (propriétaire/collaborateur)
3. Cliquez sur `Installer & Autoriser`
+![Ajout de l'accès au dépôt à OpenHands](/img/cloud/add-repo.png)
+
## Modification de l'Accès au Dépôt
Vous pouvez modifier l'accès au dépôt à tout moment :
diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
index 6430f2984e..65cd440171 100644
--- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
+++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
@@ -8,18 +8,30 @@
- [GitHubリポジトリアクセス](./github-installation#adding-repository-access)
- [GitLabリポジトリアクセス](./gitlab-installation#adding-repository-access)
+![OpenHandsにリポジトリアクセスを追加する](/img/cloud/add-repo.png)
+
## 使用方法
OpenHands Cloudリポジトリアクセスを許可した後、リポジトリの課題やプルリクエスト/マージリクエストでクラウド課題リゾルバーを使用できます。
### 課題の操作
-リポジトリで、課題に`openhands`というラベルを付けます。OpenHandsは以下を行います:
+リポジトリで、課題に`openhands`というラベルを付けるか、`@openhands`で始まるメッセージを追加します。OpenHandsは以下を行います:
1. 課題にコメントして、作業中であることを知らせます
- リンクをクリックすると、OpenHands Cloudで進捗状況を追跡できます
2. 課題が正常に解決されたと判断した場合、プルリクエスト(GitHub)またはマージリクエスト(GitLab)を開きます
3. 実行されたタスクの概要とPR/MRへのリンクを含むコメントを課題に残します
+![OpenHands課題リゾルバーの動作](/img/cloud/issue-resolver.png)
+
+#### 課題用のコマンド例
+
+以下は、課題リゾルバーで使用できるコマンドの例です:
+
+```
+@openhands 課題の説明を読んで修正してください
+```
+
### プルリクエスト/マージリクエストの操作
プルリクエスト(GitHub)またはマージリクエスト(GitLab)でOpenHandsを動作させるには、コメントで`@openhands`を言及して以下を行います:
@@ -30,3 +42,15 @@ OpenHands Cloudリポジトリアクセスを許可した後、リポジトリ
OpenHandsは以下を行います:
1. 作業中であることを知らせるコメントをします
2. リクエストされたタスクを実行します
+
+#### プルリクエスト/マージリクエスト用のコマンド例
+
+以下は、プルリクエスト/マージリクエストで使用できるコマンドの例です:
+
+```
+@openhands レビューコメントを反映してください
+```
+
+```
+@openhands マージの競合を修正し、CIが通過することを確認してください
+```
diff --git a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
index 034314ab78..0b3dd2c047 100644
--- a/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
+++ b/docs/i18n/ja/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
@@ -36,6 +36,8 @@
- ユーザーのGitHub権限(所有者/コラボレーター)
3. `インストール&承認`をクリックします
+![OpenHandsへのリポジトリアクセスの追加](/img/cloud/add-repo.png)
+
## リポジトリアクセスの変更
リポジトリアクセスはいつでも変更できます:
diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
index 56c625127f..9de5cfea79 100644
--- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
+++ b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
@@ -8,18 +8,30 @@ O Resolvedor de Problemas na Nuvem está disponível automaticamente quando voc
- [Acesso ao repositório GitHub](./github-installation#adding-repository-access)
- [Acesso ao repositório GitLab](./gitlab-installation#adding-repository-access)
+![Adicionando acesso ao repositório ao OpenHands](/img/cloud/add-repo.png)
+
## Uso
Após conceder acesso ao repositório OpenHands Cloud, você pode usar o Resolvedor de Problemas na Nuvem em issues e pull/merge requests em seus repositórios.
### Trabalhando com Issues
-No seu repositório, rotule uma issue com `openhands`. O OpenHands irá:
+No seu repositório, rotule uma issue com `openhands` ou adicione uma mensagem começando com `@openhands`. O OpenHands irá:
1. Comentar na issue para informar que está trabalhando nela
- Você pode clicar no link para acompanhar o progresso no OpenHands Cloud
2. Abrir um pull request (GitHub) ou merge request (GitLab) se determinar que o problema foi resolvido com sucesso
3. Comentar na issue com um resumo das tarefas realizadas e um link para o PR/MR
+![OpenHands resolvedor de problemas em ação](/img/cloud/issue-resolver.png)
+
+#### Exemplos de Comandos para Issues
+
+Aqui estão alguns exemplos de comandos que você pode usar com o resolvedor de problemas:
+
+```
+@openhands leia a descrição do problema e corrija-o
+```
+
### Trabalhando com Pull/Merge Requests
Para fazer o OpenHands trabalhar em pull requests (GitHub) ou merge requests (GitLab), mencione `@openhands` nos comentários para:
@@ -30,3 +42,15 @@ Para fazer o OpenHands trabalhar em pull requests (GitHub) ou merge requests (Gi
O OpenHands irá:
1. Comentar para informar que está trabalhando nisso
2. Realizar a tarefa solicitada
+
+#### Exemplos de Comandos para Pull/Merge Requests
+
+Aqui estão alguns exemplos de comandos que você pode usar com pull/merge requests:
+
+```
+@openhands reflita os comentários da revisão
+```
+
+```
+@openhands corrija os conflitos de merge e certifique-se de que o CI passa
+```
diff --git a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
index 42cfbf4a7b..e59bf6b535 100644
--- a/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
+++ b/docs/i18n/pt-BR/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
@@ -36,6 +36,8 @@ Você pode conceder ao OpenHands acesso a repositórios específicos:
- Permissões do GitHub do usuário (proprietário/colaborador)
3. Clique em `Instalar e Autorizar`
+![Adicionando acesso ao repositório ao OpenHands](/img/cloud/add-repo.png)
+
## Modificando o Acesso ao Repositório
Você pode modificar o acesso ao repositório a qualquer momento:
diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
index b70de25061..23014dedc6 100644
--- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
+++ b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/cloud/cloud-issue-resolver.md
@@ -8,18 +8,30 @@
- [GitHub仓库访问](./github-installation#adding-repository-access)
- [GitLab仓库访问](./gitlab-installation#adding-repository-access)
+![向OpenHands添加仓库访问权限](/img/cloud/add-repo.png)
+
## 使用方法
授予OpenHands Cloud仓库访问权限后,您可以在仓库的问题和拉取/合并请求中使用云问题解决器。
### 处理问题
-在您的仓库中,给问题添加`openhands`标签。OpenHands将会:
+在您的仓库中,给问题添加`openhands`标签或添加以`@openhands`开头的消息。OpenHands将会:
1. 在问题上发表评论,让您知道它正在处理
- 您可以点击链接在OpenHands Cloud上跟踪进度
2. 如果确定问题已成功解决,则打开拉取请求(GitHub)或合并请求(GitLab)
3. 在问题上发表评论,总结已执行的任务并提供PR/MR的链接
+![OpenHands问题解决器运行中](/img/cloud/issue-resolver.png)
+
+#### 问题命令示例
+
+以下是您可以在问题解决器中使用的命令示例:
+
+```
+@openhands 阅读问题描述并修复它
+```
+
### 处理拉取/合并请求
要让OpenHands处理拉取请求(GitHub)或合并请求(GitLab),在评论中提及`@openhands`以:
@@ -30,3 +42,15 @@
OpenHands将会:
1. 发表评论让您知道它正在处理
2. 执行请求的任务
+
+#### 拉取/合并请求命令示例
+
+以下是您可以在拉取/合并请求中使用的命令示例:
+
+```
+@openhands 反映审查评论
+```
+
+```
+@openhands 修复合并冲突并确保CI通过
+```
diff --git a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
index 274f504f26..6ff1086f0c 100644
--- a/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
+++ b/docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/usage/cloud/github-installation.md
@@ -36,6 +36,8 @@
- 用户的GitHub权限(所有者/协作者)
3. 点击`安装并授权`
+![向OpenHands添加仓库访问权限](/img/cloud/add-repo.png)
+
## 修改仓库访问权限
您可以随时修改仓库访问权限:
diff --git a/docs/modules/usage/cloud/cloud-issue-resolver.md b/docs/modules/usage/cloud/cloud-issue-resolver.md
index 12c7781968..acd495e175 100644
--- a/docs/modules/usage/cloud/cloud-issue-resolver.md
+++ b/docs/modules/usage/cloud/cloud-issue-resolver.md
@@ -7,6 +7,8 @@ The Cloud Issue Resolver automates code fixes and provides intelligent assistanc
The Cloud Issue Resolver is available automatically when you grant OpenHands Cloud repository access:
- [GitHub repository access](./github-installation#adding-repository-access)
+![Adding repository access to OpenHands](/img/cloud/add-repo.png)
+
## Usage
After granting OpenHands Cloud repository access, you can use the Cloud Issue Resolver on issues and pull requests in your repositories.
@@ -20,6 +22,16 @@ On your repository, label an issue with `openhands` or add a message starting wi
2. Open a pull request if it determines that the issue has been successfully resolved
3. Comment on the issue with a summary of the performed tasks and a link to the PR
+![OpenHands issue resolver in action](/img/cloud/issue-resolver.png)
+
+#### Example Commands for Issues
+
+Here are some examples of commands you can use with the issue resolver:
+
+```
+@openhands read the issue description and fix it
+```
+
### Working with Pull Requests
To get OpenHands to work on pull requests, mention `@openhands` in comments to:
@@ -30,3 +42,15 @@ To get OpenHands to work on pull requests, mention `@openhands` in comments to:
OpenHands will:
1. Comment to let you know it is working on it
2. Perform the requested task
+
+#### Example Commands for Pull Requests
+
+Here are some examples of commands you can use with pull requests:
+
+```
+@openhands reflect the review comments
+```
+
+```
+@openhands fix the merge conflicts and make sure that CI passes
+```
diff --git a/docs/modules/usage/cloud/github-installation.md b/docs/modules/usage/cloud/github-installation.md
index 4a22c0ccae..6aceabb220 100644
--- a/docs/modules/usage/cloud/github-installation.md
+++ b/docs/modules/usage/cloud/github-installation.md
@@ -36,6 +36,8 @@ You can grant OpenHands access to specific repositories:
- User's GitHub permissions (owner/collaborator)
3. Click `Install & Authorize`
+![Adding repository access to OpenHands](/img/cloud/add-repo.png)
+
## Modifying Repository Access
You can modify repository access at any time by visiting the Settings page and selecting `Configure GitHub Repositories` under the `Git` tab.
diff --git a/docs/static/img/cloud/add-repo.png b/docs/static/img/cloud/add-repo.png
new file mode 100644
index 0000000000..61b55a01a6
Binary files /dev/null and b/docs/static/img/cloud/add-repo.png differ
diff --git a/docs/static/img/cloud/issue-resolver.png b/docs/static/img/cloud/issue-resolver.png
new file mode 100644
index 0000000000..84ffe97604
Binary files /dev/null and b/docs/static/img/cloud/issue-resolver.png differ