[Docs]: Cloud Openhands (OpenHands#6747)

malhotra5 · openhands-agent · mamoodi · web-flow · commit ce42e2210554 · 2025-02-17T18:39:49.000Z
Co-authored-by: openhands &lt;openhands@all-hands.dev&gt;
Co-authored-by: mamoodi &lt;mamoodiha@gmail.com&gt;
diff --git a/docs/modules/usage/cloud/cloud-github-resolver.md b/docs/modules/usage/cloud/cloud-github-resolver.md
@@ -0,0 +1,21 @@
+# Cloud GitHub Resolver
+
+The GitHub Resolver automates code fixes and provides intelligent assistance for your repositories.
+
+## Setup
+
+The Cloud Github Resolver is available automatically when you
+[grant OpenHands Cloud repository access](./openhands-cloud.md#adding-repositories).
+
+## Usage
+
+### Issues
+
+On your repository, label an issue with `openhands`. OpenHands will attempt to fix the issue.
+
+### Pull Requests
+
+In order to get OpenHands to work on pull requests, use `@openhands` in top level or single inline comments to:
+     - Ask questions
+     - Request updates
+     - Get code explanations
diff --git a/docs/modules/usage/cloud/openhands-cloud.md b/docs/modules/usage/cloud/openhands-cloud.md
@@ -0,0 +1,31 @@
+# Openhands Cloud
+
+This document provides information about the hosted version of OpenHands.
+
+## Getting Started
+
+After visiting OpenHands Cloud, you will be asked to connect with your GitHub account:
+1. After reading and accepting the terms of service, click `Connect to GitHub`.
+2. Then click `Authorize OpenHands by All Hands AI`.
+   - Openhands requests short-lived tokens (8-hour expiry) with these permissions:
+     - Actions: Read and write
+     - Administration: Read-only
+     - Commit statuses: Read and write
+     - Contents: Read and write
+     - Issues: Read and write
+     - Metadata: Read-only
+     - Pull requests: Read and write
+     - Webhooks: Read and write
+     - Workflows: Read and write
+
+## Adding Repositories
+
+You can grant OpenHands specific repository access:
+1. Under the `Select a GitHub project` dropdown, select `Add more repositories...`.
+2. Select the organization, then choose the specific repositories to grant OpenHands access to.
+   - Repository access for a user is granted based on:
+     - Granted permission for the repository.
+     - User's GitHub permissions (owner/collaborator).
+
+You can manage repository access any time by following the above workflow or visiting the Settings page and selecting
+`Configure GitHub Repositories` under the `GitHub Settings` section.
diff --git a/docs/sidebars.ts b/docs/sidebars.ts
@@ -42,7 +42,7 @@ const sidebars: SidebarsConfig = {
               id: 'usage/prompting/microagents-public',
             },
           ],
-        }
+        },
       ],
     },
     {
@@ -69,6 +69,23 @@ const sidebars: SidebarsConfig = {
           label: 'Github Actions',
           id: 'usage/how-to/github-action',
         },
+        {
+          type: 'category',
+          label: 'Cloud',
+          items: [
+            {
+              type: 'doc',
+              label: 'Openhands Cloud',
+              id: 'usage/cloud/openhands-cloud',
+            },
+
+            {
+              type: 'doc',
+              label: 'Cloud GitHub Resolver',
+              id: 'usage/cloud/cloud-github-resolver',
+            },
+          ],
+        },
       ],
     },
     {
@@ -185,7 +202,7 @@ const sidebars: SidebarsConfig = {
       type: 'doc',
       label: 'About',
       id: 'usage/about',
-    }
+    },
   ],
 };
 
