From c777cfeacfea777730f8c176e6992fe3a81aaad1 Mon Sep 17 00:00:00 2001
From: OpenHands <opendevin@all-hands.dev>
Date: Tue, 1 Oct 2024 12:08:57 -0400
Subject: [PATCH] Fix issue #4113: Document github action (#4124)

Co-authored-by: Graham Neubig <neubig@gmail.com>
---
 docs/modules/usage/getting-started.mdx     |  3 +--
 docs/modules/usage/how-to/github-action.md | 15 +++++++++++++++
 docs/sidebars.ts                           |  4 ++++
 3 files changed, 20 insertions(+), 2 deletions(-)
 create mode 100644 docs/modules/usage/how-to/github-action.md

diff --git a/docs/modules/usage/getting-started.mdx b/docs/modules/usage/getting-started.mdx
index 7dad34b71922..731bc5a830a0 100644
--- a/docs/modules/usage/getting-started.mdx
+++ b/docs/modules/usage/getting-started.mdx
@@ -32,8 +32,7 @@ docker run -it --pull=always \
     ghcr.io/all-hands-ai/openhands:0.9
 ```
 
-You can also run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/modules/usage/how-to/headless-mode),
-or as an [interactive CLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode).
+You can also run OpenHands in a scriptable [headless mode](https://docs.all-hands.dev/modules/usage/how-to/headless-mode), as an [interactive CLI](https://docs.all-hands.dev/modules/usage/how-to/cli-mode), or using the [OpenHands GitHub Action](https://docs.all-hands.dev/modules/usage/how-to/github-action).
 
 ## Setup
 
diff --git a/docs/modules/usage/how-to/github-action.md b/docs/modules/usage/how-to/github-action.md
new file mode 100644
index 000000000000..102a3ec6aa78
--- /dev/null
+++ b/docs/modules/usage/how-to/github-action.md
@@ -0,0 +1,15 @@
+# Using the OpenHands GitHub Action
+
+This guide explains how to use the OpenHands GitHub Action, both within the OpenHands repository and in your own projects.
+
+## Using the Action in the OpenHands Repository
+
+To use the OpenHands GitHub Action in the OpenHands repository, an OpenHands maintainer can:
+
+1. Create an issue in the repository.
+2. Add the `fix-me` label to the issue.
+3. The action will automatically trigger and attempt to resolve the issue.
+
+## Installing the Action in a New Repository
+
+To install the OpenHands GitHub Action in your own repository, follow the [directions in the OpenHands Resolver repo](https://github.com/All-Hands-AI/OpenHands-resolver?tab=readme-ov-file#using-the-github-actions-workflow).
diff --git a/docs/sidebars.ts b/docs/sidebars.ts
index 3b4810efe019..396bba809684 100644
--- a/docs/sidebars.ts
+++ b/docs/sidebars.ts
@@ -72,6 +72,10 @@ const sidebars: SidebarsConfig = {
           type: 'doc',
           id: 'usage/how-to/headless-mode',
         },
+        {
+          type: 'doc',
+          id: 'usage/how-to/github-action',
+        },
         {
           type: 'doc',
           id: 'usage/how-to/custom-sandbox-guide',