diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000000..d15eb6aa1b --- /dev/null +++ b/docs/README.md @@ -0,0 +1,17 @@ +# Setup + +``` +npm install -g mint +``` + +or + +``` +yarn global add mint +``` + +# Preview + +``` +mint dev +``` \ No newline at end of file diff --git a/docs/docs.json b/docs/docs.json index f51db60f89..4beaafa250 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -34,7 +34,8 @@ "group": "Integrations", "pages": [ "usage/cloud/github-installation", - "usage/cloud/gitlab-installation" + "usage/cloud/gitlab-installation", + "usage/cloud/slack-installation" ] }, "usage/cloud/cloud-ui", diff --git a/docs/static/img/slack-create-convo.png b/docs/static/img/slack-create-convo.png new file mode 100644 index 0000000000..5cdd58542b Binary files /dev/null and b/docs/static/img/slack-create-convo.png differ diff --git a/docs/static/img/slack-pro-tip.png b/docs/static/img/slack-pro-tip.png new file mode 100644 index 0000000000..74f211f2f9 Binary files /dev/null and b/docs/static/img/slack-pro-tip.png differ diff --git a/docs/static/img/slack-results-and-follow-up.png b/docs/static/img/slack-results-and-follow-up.png new file mode 100644 index 0000000000..26a434336a Binary files /dev/null and b/docs/static/img/slack-results-and-follow-up.png differ diff --git a/docs/usage/cloud/slack-installation.mdx b/docs/usage/cloud/slack-installation.mdx new file mode 100644 index 0000000000..7d867aa5f6 --- /dev/null +++ b/docs/usage/cloud/slack-installation.mdx @@ -0,0 +1,52 @@ +--- +title: Slack Integration - Coming soon... +description: This guide walks you through installing the OpenHands Slack app. +--- + +This integration is not live yet, but will be available soon. + +## Prerequisites + +- You are a slack workspace admin +- Access to OpenHands Cloud + +## Installation Steps + +1. Log in to [OpenHands Cloud](https://app.all-hands.dev) +2. Click the button below to OpenHands Slack App Add to Slack +3. In the top right corner, select the workspace to install the OpenHands Slack app. +4. Review permissions and click allow + +## Working With the Slack App + +To start a new conversation, you can mention `@openhands` in a new message or a thread inside any Slack channel. + +Once a conversation is started, all thread messages underneath it will be follow-up messages to OpenHands. + +To send follow-up messages for the same conversation, mention `@openhands` in a thread reply to the original message. You must be the user who started the conversation. + +## Example conversation + +### Start a new conversation, and select repo + +Conversation is started by mentioning `@openhands`. + +![slack-create-convo.png](/static/img/slack-create-convo.png) + +### See agent response and send follow up messages + +Initial request is followed up by mentioning `@openhands` in a thread reply. + +![slack-results-and-follow-up.png](/static/img/slack-results-and-follow-up.png) + +## Pro tip + +You can mention a repo name when starting a new conversation in the following formats + +1. "My-Repo" repo (e.g `@openhands in the openhands repo ...`) +2. "All-Hands-AI/OpenHands" (e.g `@openhands in All-Hands-AI/OpenHands ...`) + +The repo match is case insensitive. If a repo name match is made, it will kick off the conversation. +If the repo name partially matches against, multiple repos, you'll be asked to select a repo from the filtered list. + +![slack-pro-tip.png](/static/img/slack-pro-tip.png)