Skip to content

Commit 825a0ac

Browse files
committed
Slack guide
1 parent 697f954 commit 825a0ac

File tree

4 files changed

+53
-54
lines changed

4 files changed

+53
-54
lines changed

docs/roo-code-cloud/slack-integration.mdx

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -12,63 +12,63 @@ image: /img/social-share.jpg
1212

1313
# Slack Integration
1414

15-
The Roo Code Slack integration brings your AI development team directly into your chat workspace. You can summon agents to explain code, plan new features, or execute coding tasks without leaving Slack.
15+
The Roo Code Slack integration brings your Cloud Agent team directly into your chat workspace. You can summon agents to explain code, plan new features, or execute coding tasks without leaving Slack, and they get along quite well with humans.
1616

17-
<img src="/img/slack-integration/overview.png" alt="Slack Integration Overview" width="800" />
17+
Summoning agents from Slack in public channels is an effective way to bring the entire team into the process, to learn by example how to best leverage Cloud Agents (and the information/outcomes they produce).
18+
19+
---
1820

1921
## Setting Up
2022

21-
1. **Install the Slack App**: Go to [app.roocode.com/integrations](https://app.roocode.com/integrations) and click "Connect Slack".
22-
2. **Authorize**: Grant the necessary permissions for the Roo Code bot to read messages and post replies in your workspace.
23-
3. **Invite to Channels**: Add the `@Roomote` bot to the channels where you want to use it.
23+
You'll be prompted to connect to Slack when fist signing up for your account. But if you dismiss it, you can do it later:
24+
25+
1. Go to your personal or org settings (if avaialble) in the top right user menu
26+
2. Click on "Connect" and follow the process
27+
3. Add the `@Roomote` bot to the channels where you want it to be available
28+
29+
**Note:** The Slack integration will not watch your conversations unless you specifically mention `@Roomote`.
2430

25-
## Interactions
31+
## Calling Agents
2632

27-
To interact with Roo Code agents, simply mention `@Roomote` in any channel where the bot is present.
33+
1. To interact with Roo Code agents, simply mention `@Roomote` in any channel where the bot is present to start a thread, giving it instructions. It will react with 👀 to acknowledge it.
34+
2. Then, the app will ask you what Agent to use with what repository. You can choose "all repositories", but the more focused you can make the agent, the higher the chances of good results.
35+
<img src="/img/integrations/slack-confirm.png" alt="The Slack app checking what agent and repo to use" width="280" />
36+
3. If the agent has any questions, it will get back to you with options, like this:
37+
<img src="/img/integrations/slack-question.png" alt="The Slack app asking for an answer" width="280" />
38+
4. Once done, the agent will never directly modify your code. If it was a coding task, it will push a branch or create a PR, depending on how it's configured, but it will never touch `main`/`master` or production.
39+
40+
You can always send messages directly though by mentioning **@Roomote** again in the thread. It will keep context.
41+
42+
## Examples
43+
44+
### Planning Projects
2845

29-
### 1. Planning Features (Planner Agent)
3046
Start a thread to discuss and plan a new feature with your team and the AI.
3147

32-
> **User:** `@Roomote We need to add a 'Forgot Password' flow to the user service. Can you plan this out?`
33-
>
34-
> **@Roomote:** 👀 *Thinking...*
35-
>
36-
> **@Roomote:** **(Planner Agent)** Here is a proposed implementation plan for the Forgot Password flow:
37-
> 1. Create `PasswordResetToken` model...
38-
> 2. Add API endpoint `/api/auth/forgot-password`...
39-
> ...
40-
41-
### 2. Explaining Code (Explainer Agent)
42-
Ask questions about your codebase to get immediate answers.
43-
44-
> **User:** `@Roomote explain how the authentication middleware handles JWT tokens in the backend repo`
45-
>
46-
> **@Roomote:** **(Explainer Agent)** The authentication middleware in `backend/src/middleware/auth.ts` works as follows:
47-
> 1. Extracts the token from the `Authorization` header.
48-
> 2. Verifies the signature using `JWT_SECRET`.
49-
> 3. Attaches the decoded user payload to `req.user`.
50-
51-
### 3. Executing Tasks (Coder Agent)
52-
Trigger coding tasks directly from chat.
48+
> **@Roomote** We need to add a 'Forgot Password' flow to the user service. Can you plan this out?
5349
54-
> **User:** `@Roomote create a new API endpoint for user profile updates based on the plan we just discussed`
55-
>
56-
> **@Roomote:** **(Coder Agent)** I'll get started on that. I've created a new task to implement the user profile update endpoint. You can follow the progress [here](https://app.roocode.com/tasks/123).
50+
Pick a Planner agent wait for the plan. You can then run it by your team or give it to the Coder agent to build.
5751

58-
## Workflow
52+
### Explaining Code
53+
54+
Ask questions about your codebase to get immediate answers. Great for understanding bugs or confusing behavior.
55+
56+
> **@Roomote** why may users be getting double confirmation emails after completing their purchase?
57+
58+
But wait, agents are actually smart enough to understand the context of threads. So you can, after some back-and-forth with a colleague, simply ask:
59+
60+
> **@Roomote** why is this hapening?
61+
62+
And it will know what to do.
63+
64+
### Writing Code
65+
66+
Trigger coding tasks directly from chat.
5967

60-
1. **Invoke**: Mention `@Roomote` with your request.
61-
2. **Acknowledge**: The bot reacts with 👀 to confirm it's processing.
62-
3. **Clarify**: If needed, the bot will ask follow-up questions to identify the correct:
63-
- **Agent Type**: (e.g., Planner vs. Coder)
64-
- **Repository**: Which codebase to apply the changes to.
65-
4. **Execute**: The selected agent runs in the cloud.
66-
5. **Report**: The bot posts the result back to the thread.
68+
> **@Roomote** create a new API endpoint for user profile updates, including support for profile image upload
6769
68-
## Use Cases
70+
> **@Roomote** fix this bug: `\<BUG_URL\>`
6971
70-
- **Team Knowledge Sharing**: Ask for an explanation in a public channel so the whole team benefits from the answer.
71-
- **Brainstorming**: Use the Planner agent to flesh out ideas during a slack huddle.
72-
- **Quick Fixes**: Trigger simple tasks without context switching to your IDE.
72+
> **@Roomote** build this: `[paste an implementation plan from the planner]`
7373
74-
[Connect Slack Now](https://app.roocode.com/integrations)
74+
The possibilities are enourmous.

src/css/custom.css

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1637,11 +1637,13 @@ main[class*="docMainContainer"] {
16371637

16381638
/* Inline code styling */
16391639
.theme-doc-markdown code {
1640-
background-color: hsl(var(--background) / 0.6) !important;
1641-
border: 1px solid hsl(var(--border) / 0.3) !important;
1642-
padding: 0.2rem 0.4rem !important;
1643-
font-size: 0.85em !important;
1644-
border-radius: 0.375rem !important;
1640+
background-color: hsl(var(--card));
1641+
border: 1px solid hsl(var(--border)) !important;
1642+
border-radius: 0.35rem;
1643+
padding: 0.2rem 0.4rem 0.3rem !important;
1644+
font-size: 0.9em !important;
1645+
font-weight: 500 !important;
1646+
16451647
}
16461648

16471649
/* Code block title */
@@ -1655,20 +1657,17 @@ main[class*="docMainContainer"] {
16551657
font-weight: 500 !important;
16561658
}
16571659

1658-
/* Blockquotes like roocode.com */
16591660
.theme-doc-markdown blockquote {
16601661
border-left: 4px solid hsl(var(--border));
16611662
background: hsl(var(--background) / 0.5);
16621663
backdrop-filter: blur(16px);
1663-
padding: 1rem 1.5rem;
16641664
margin: var(--figure-margin) 0;
1665-
border-radius: 0 calc(var(--radius)) calc(var(--radius)) 0;
1665+
padding: calc(var(--figure-margin)/2) var(--figure-margin);
16661666
}
16671667

16681668
.theme-doc-markdown blockquote p {
16691669
margin-bottom: 0;
16701670
color: hsl(var(--muted-foreground));
1671-
font-style: italic;
16721671
}
16731672

16741673
/* Admonitions (alerts) with roocode.com style */
50.6 KB
Loading
67 KB
Loading

0 commit comments

Comments
 (0)