From 087f8bc8efab69a0fe5d028592bf43dc2c936e8c Mon Sep 17 00:00:00 2001 From: joelaguero Date: Wed, 21 May 2025 09:34:02 -0700 Subject: [PATCH 1/2] Clarify installation instructions --- docs/integrations/slack.mdx | 54 ++++++++++++++++++++++--------------- 1 file changed, 33 insertions(+), 21 deletions(-) diff --git a/docs/integrations/slack.mdx b/docs/integrations/slack.mdx index 35ba06404..524213912 100644 --- a/docs/integrations/slack.mdx +++ b/docs/integrations/slack.mdx @@ -4,9 +4,26 @@ sidebarTitle: "Slack" icon: "slack" --- +Connect Codegen to your Slack workspace to enable seamless communication between agents and your team. + -Connect Codegen to your Slack workspace to enable seamless communication between agents and your team. +## Installation + +Add the Codegen integration for Slack to your workspace to enable agent communication. + + + To install the integration, create a Codegen account and visit Integrations > Slack to connect your Slack workspace. + + + + Configure channel access carefully to ensure agents communicate in the + appropriate places. + ## Capabilities & Functions @@ -22,39 +39,34 @@ Codegen functions as a full-fledged software engineer that you can interact with All of these capabilities are accessible through natural language interactions in your Slack workspace, allowing your team to leverage Codegen's assistance without context switching between different platforms. -## Installation +## Configuration Instructions -Add the Codegen app for Slack to your workspace to enable agent communication. +After installing the integration for Slack from the Slack Marketplace, follow these steps to configure it for your team: - - Install the Codegen app for Slack from the Slack Marketplace and choose the - channels it can access. - +### Channel Setup +- **Invite the Codegen bot**: Type `/invite @codegen` in any channel where you want Codegen to participate. +- (Optional) **Create a dedicated channel**: Some Codegen users find creating a channel like `#codegen` helpful for general agent interactions and to encourage experimentation. - - Configure channel access carefully to ensure agents communicate in the - appropriate places. - +### Trigger Configuration +Codegen agents can be triggered in several ways: +- **Direct mentions**: Type `@codegen` followed by your request in any channel where the bot is present. +- **Thread replies**: Tag `@codegen` in threads to continue the conversation. +- **Direct messages**: Send a DM to the Codegen bot for private conversations. ## Message Response Behavior Codegen responds to the following messages in Slack: - **Direct Messages:** - - - Responds to any DM sent to the Codegen app for Slack + - Responds to any DM sent to the Codegen integration for Slack - Has visibility into previous messages in the conversation (not just threaded replies) - This provides a more natural conversation experience as many users don't thread messages in DMs - **Channel Messages:** - - Responds to any message that @mentions Codegen in channels where the app for Slack is installed + - Responds to any message that @mentions Codegen in channels where the integration for Slack is installed - Only has visibility into the local context of the thread/conversation - - Sending subsequent messages within a thread routes to the same agent - - New messages in an active thread will interrupt the agent if it's currently working + - Sending subsequent messages within a thread routes to the same agent (tag `@codegen` to trigger) + - New messages to `@codegen` in an active thread will interrupt the agent if it's currently working ## Data Privacy and Security @@ -66,4 +78,4 @@ Codegen responds to the following messages in Slack: **User Permissions and Access Control:** -Codegen's actions on connected repositories are governed by the permissions of the user who initiated the interaction via Slack. The bot itself does not have independent permissions to repositories. Access to repositories and the ability to trigger actions are determined by the Codegen user's authenticated account and their associated repository permissions. We recommend configuring channel access carefully during installation to ensure the Codegen app for Slack is only present in channels where its use is appropriate. +Codegen's actions on connected repositories are governed by the permissions of the user who initiated the interaction via Slack. The bot itself does not have independent permissions to repositories. Access to repositories and the ability to trigger actions are determined by the Codegen user's authenticated account and their associated repository permissions. We recommend configuring channel access carefully during installation to ensure the Codegen integration for Slack is only present in channels where its use is appropriate. \ No newline at end of file From 839652160f3717246b02a1b964b9648b032b5466 Mon Sep 17 00:00:00 2001 From: joelaguero Date: Wed, 21 May 2025 09:53:31 -0700 Subject: [PATCH 2/2] finish slack doc updates --- docs/integrations/slack.mdx | 29 +++++++++++++++++++++-------- 1 file changed, 21 insertions(+), 8 deletions(-) diff --git a/docs/integrations/slack.mdx b/docs/integrations/slack.mdx index 524213912..2fae18620 100644 --- a/docs/integrations/slack.mdx +++ b/docs/integrations/slack.mdx @@ -10,14 +10,14 @@ Connect Codegen to your Slack workspace to enable seamless communication between ## Installation -Add the Codegen integration for Slack to your workspace to enable agent communication. +To use this integration, follow the installation and configuration steps below. - To install the integration, create a Codegen account and visit Integrations > Slack to connect your Slack workspace. + Create a Codegen account and visit Integrations > Slack to connect your Slack workspace. @@ -25,6 +25,8 @@ Add the Codegen integration for Slack to your workspace to enable agent communic appropriate places. +After installation, proceed to the Configuration Instructions below to finish setup and begin using Codegen in your Slack workspace. + ## Capabilities & Functions Codegen functions as a full-fledged software engineer that you can interact with directly through Slack. When responding to messages in Slack, Codegen can: @@ -41,21 +43,26 @@ All of these capabilities are accessible through natural language interactions i ## Configuration Instructions -After installing the integration for Slack from the Slack Marketplace, follow these steps to configure it for your team: +After installing the integration from the Slack Marketplace, configure the bot by inviting it to relevant channels and setting up triggers so Codegen knows when and how to respond. ### Channel Setup - **Invite the Codegen bot**: Type `/invite @codegen` in any channel where you want Codegen to participate. - (Optional) **Create a dedicated channel**: Some Codegen users find creating a channel like `#codegen` helpful for general agent interactions and to encourage experimentation. -### Trigger Configuration -Codegen agents can be triggered in several ways: +## What Triggers Slack Messages from Codegen +These triggers kick off new Codegen requests: - **Direct mentions**: Type `@codegen` followed by your request in any channel where the bot is present. - **Thread replies**: Tag `@codegen` in threads to continue the conversation. - **Direct messages**: Send a DM to the Codegen bot for private conversations. -## Message Response Behavior +In addition, Codegen will send messages to Slack when: +- It starts work on a request you made +- It receives an additional message while working on a request +- It completes a task, code change, or research request + +## How Codegen Responds to Slack Messages -Codegen responds to the following messages in Slack: +Codegen only responds when tagged or messaged directly. Use these approaches to ensure your request reaches it: - **Direct Messages:** - Responds to any DM sent to the Codegen integration for Slack @@ -78,4 +85,10 @@ Codegen responds to the following messages in Slack: **User Permissions and Access Control:** -Codegen's actions on connected repositories are governed by the permissions of the user who initiated the interaction via Slack. The bot itself does not have independent permissions to repositories. Access to repositories and the ability to trigger actions are determined by the Codegen user's authenticated account and their associated repository permissions. We recommend configuring channel access carefully during installation to ensure the Codegen integration for Slack is only present in channels where its use is appropriate. \ No newline at end of file +Codegen's actions on connected repositories are governed by the permissions of the user who initiated the interaction via Slack. The bot itself does not have independent permissions to repositories. Access to repositories and the ability to trigger actions are determined by the Codegen user's authenticated account and their associated repository permissions. We recommend configuring channel access carefully during installation to ensure the Codegen integration for Slack is only present in channels where its use is appropriate. + +## Tips for Effective Use + +- Use direct language when asking Codegen for help (e.g., "Add pagination to the results view"). +- Mention Codegen early in the message so it is triggered promptly. +- Use threads for ongoing conversations with Codegen so it has access to previous context. \ No newline at end of file