Skip to content

Commit 087f8bc

Browse files
committed
Clarify installation instructions
1 parent 5ba123b commit 087f8bc

1 file changed

Lines changed: 33 additions & 21 deletions

File tree

docs/integrations/slack.mdx

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,26 @@ sidebarTitle: "Slack"
44
icon: "slack"
55
---
66

7+
Connect Codegen to your Slack workspace to enable seamless communication between agents and your team.
8+
79
<img src="/images/slack.png" />
810

9-
Connect Codegen to your Slack workspace to enable seamless communication between agents and your team.
11+
## Installation
12+
13+
Add the Codegen integration for Slack to your workspace to enable agent communication.
14+
15+
<Card
16+
title="Add Codegen to Slack"
17+
icon="slack"
18+
href="https://codegen.com/integrations"
19+
>
20+
To install the integration, create a Codegen account and visit Integrations > Slack to connect your Slack workspace.
21+
</Card>
22+
23+
<Note>
24+
Configure channel access carefully to ensure agents communicate in the
25+
appropriate places.
26+
</Note>
1027

1128
## Capabilities & Functions
1229

@@ -22,39 +39,34 @@ Codegen functions as a full-fledged software engineer that you can interact with
2239

2340
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.
2441

25-
## Installation
42+
## Configuration Instructions
2643

27-
Add the Codegen app for Slack to your workspace to enable agent communication.
44+
After installing the integration for Slack from the Slack Marketplace, follow these steps to configure it for your team:
2845

29-
<Card
30-
title="Add Codegen to Slack"
31-
icon="slack"
32-
href="https://codegen.sh/integrations"
33-
>
34-
Install the Codegen app for Slack from the Slack Marketplace and choose the
35-
channels it can access.
36-
</Card>
46+
### Channel Setup
47+
- **Invite the Codegen bot**: Type `/invite @codegen` in any channel where you want Codegen to participate.
48+
- (Optional) **Create a dedicated channel**: Some Codegen users find creating a channel like `#codegen` helpful for general agent interactions and to encourage experimentation.
3749

38-
<Note>
39-
Configure channel access carefully to ensure agents communicate in the
40-
appropriate places.
41-
</Note>
50+
### Trigger Configuration
51+
Codegen agents can be triggered in several ways:
52+
- **Direct mentions**: Type `@codegen` followed by your request in any channel where the bot is present.
53+
- **Thread replies**: Tag `@codegen` in threads to continue the conversation.
54+
- **Direct messages**: Send a DM to the Codegen bot for private conversations.
4255

4356
## Message Response Behavior
4457

4558
Codegen responds to the following messages in Slack:
4659

4760
- **Direct Messages:**
48-
49-
- Responds to any DM sent to the Codegen app for Slack
61+
- Responds to any DM sent to the Codegen integration for Slack
5062
- Has visibility into previous messages in the conversation (not just threaded replies)
5163
- This provides a more natural conversation experience as many users don't thread messages in DMs
5264

5365
- **Channel Messages:**
54-
- Responds to any message that @mentions Codegen in channels where the app for Slack is installed
66+
- Responds to any message that @mentions Codegen in channels where the integration for Slack is installed
5567
- Only has visibility into the local context of the thread/conversation
56-
- Sending subsequent messages within a thread routes to the same agent
57-
- New messages in an active thread will interrupt the agent if it's currently working
68+
- Sending subsequent messages within a thread routes to the same agent (tag `@codegen` to trigger)
69+
- New messages to `@codegen` in an active thread will interrupt the agent if it's currently working
5870

5971
## Data Privacy and Security
6072

@@ -66,4 +78,4 @@ Codegen responds to the following messages in Slack:
6678

6779
**User Permissions and Access Control:**
6880

69-
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.
81+
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.

0 commit comments

Comments
 (0)