Skip to content

Commit 53ab341

Browse files
Thomas StrombergThomas Stromberg
Thomas Stromberg
authored and
Thomas Stromberg
committed
add discord documentation
1 parent 28dec2e commit 53ab341

File tree

1 file changed

+201
-0
lines changed

1 file changed

+201
-0
lines changed

‎src/reviewgoose/discord.njk‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
---
2+
layout: base.njk
3+
title: reviewGOOSE:Discord Integration
4+
---
5+
6+
<section class="rg-slack-hero">
7+
<div class="rg-slack-hero__container">
8+
<div class="rg-slack-hero__content">
9+
<div class="rg-slack-hero__text">
10+
<h1 class="rg-slack-hero__title">Discord Integration <span style="font-size: 0.5em; color: #888;">(Preview)</span></h1>
11+
<p class="rg-slack-hero__headline">PR updates where your team already works.</p>
12+
<p class="rg-slack-hero__description">
13+
Auto-threads PRs in forum channels. Smart notifications in your timezone. No more asking "is anyone looking at this?"
14+
</p>
15+
<div class="rg-slack-hero__buttons">
16+
<a href="https://docs.codegroove.dev/reviewgoose/discord/" class="rg-slack-hero__button rg-slack-hero__button--primary">Setup Guide</a>
17+
<a href="https://discord.com/oauth2/authorize?client_id=1461368540190871831&permissions=2147485696&scope=bot%20applications.commands" class="rg-slack-hero__button rg-slack-hero__button--secondary">Install Discord Bot</a>
18+
</div>
19+
<p style="margin-top: 1rem; font-size: 0.9em; color: #666;">
20+
<strong>Preview:</strong> Discord support is currently in preview. DM notifications and daily reports are not fully tested yet.
21+
</p>
22+
</div>
23+
<div class="rg-slack-hero__image">
24+
<i class="ri-discord-fill"></i>
25+
</div>
26+
</div>
27+
</div>
28+
</section>
29+
30+
<section class="rg-slack-features">
31+
<div class="rg-slack-features__container">
32+
<h2 class="rg-slack-features__title">Features</h2>
33+
<div class="rg-slack-features__grid">
34+
<div class="rg-slack-features__card">
35+
<div class="rg-slack-features__card-content">
36+
<span class="rg-slack-features__emoji">🧵</span>
37+
<div>
38+
<h3 class="rg-slack-features__card-title">Forum Threads</h3>
39+
<p class="rg-slack-features__card-description">Each PR gets its own thread in forum channels. Status updates appear as replies. Clean organization.</p>
40+
</div>
41+
</div>
42+
</div>
43+
44+
<div class="rg-slack-features__card">
45+
<div class="rg-slack-features__card-content">
46+
<span class="rg-slack-features__emoji">🎯</span>
47+
<div>
48+
<h3 class="rg-slack-features__card-title">Smart DM Delays</h3>
49+
<p class="rg-slack-features__card-description">If you're in the channel, DM waits 65 minutes. Not in the channel? Immediate DM. Reduces noise.</p>
50+
</div>
51+
</div>
52+
</div>
53+
54+
<div class="rg-slack-features__card">
55+
<div class="rg-slack-features__card-content">
56+
<span class="rg-slack-features__emoji">🌅</span>
57+
<div>
58+
<h3 class="rg-slack-features__card-title">Daily Reminders</h3>
59+
<p class="rg-slack-features__card-description">Summary of PRs waiting on you, delivered 6-11:30am in your local timezone. Start your day informed.</p>
60+
</div>
61+
</div>
62+
</div>
63+
64+
<div class="rg-slack-features__card">
65+
<div class="rg-slack-features__card-content">
66+
<span class="rg-slack-features__emoji">🔄</span>
67+
<div>
68+
<h3 class="rg-slack-features__card-title">Auto-Discovery</h3>
69+
<p class="rg-slack-features__card-description">Repos automatically map to same-named channels. `backend` repo posts to #backend. Zero config.</p>
70+
</div>
71+
</div>
72+
</div>
73+
74+
<div class="rg-slack-features__card">
75+
<div class="rg-slack-features__card-content">
76+
<span class="rg-slack-features__emoji">👥</span>
77+
<div>
78+
<h3 class="rg-slack-features__card-title">User Mapping</h3>
79+
<p class="rg-slack-features__card-description">Maps GitHub users to Discord users via username matching or explicit configuration. @mentions work automatically.</p>
80+
</div>
81+
</div>
82+
</div>
83+
84+
<div class="rg-slack-features__card">
85+
<div class="rg-slack-features__card-content">
86+
<span class="rg-slack-features__emoji">💬</span>
87+
<div>
88+
<h3 class="rg-slack-features__card-title">Text & Forum Channels</h3>
89+
<p class="rg-slack-features__card-description">Works with both forum channels (threaded) and text channels (flat messages). Choose what fits your workflow.</p>
90+
</div>
91+
</div>
92+
</div>
93+
</div>
94+
</div>
95+
</section>
96+
97+
<section class="rg-slack-setup">
98+
<div class="rg-slack-setup__container">
99+
<h2 class="rg-slack-setup__title">Setup Guide</h2>
100+
<div class="rg-slack-setup__steps">
101+
<div class="rg-slack-setup__step">
102+
<div class="rg-slack-setup__number">1</div>
103+
<div class="rg-slack-setup__content">
104+
<h3 class="rg-slack-setup__step-title">Install reviewGOOSE:GitHub</h3>
105+
<p class="rg-slack-setup__step-text">Add the reviewGOOSE:GitHub App to your organization's repos.</p>
106+
<a href="https://github.com/apps/reviewgoose" class="rg-slack-setup__link">Install reviewGOOSE:GitHub App</a>
107+
</div>
108+
</div>
109+
110+
<div class="rg-slack-setup__step">
111+
<div class="rg-slack-setup__number">2</div>
112+
<div class="rg-slack-setup__content">
113+
<h3 class="rg-slack-setup__step-title">Install Discord Bot</h3>
114+
<p class="rg-slack-setup__step-text">Add reviewGOOSE to your Discord server.</p>
115+
<a href="https://discord.com/oauth2/authorize?client_id=1461368540190871831&permissions=2147485696&scope=bot%20applications.commands" class="rg-slack-setup__link">Add to Discord</a>
116+
</div>
117+
</div>
118+
119+
<div class="rg-slack-setup__step">
120+
<div class="rg-slack-setup__number">3</div>
121+
<div class="rg-slack-setup__content">
122+
<h3 class="rg-slack-setup__step-title">Get Discord IDs</h3>
123+
<p class="rg-slack-setup__step-text">Enable Developer Mode (Settings → Advanced), then right-click server name → Copy Server ID. Right-click users to get User IDs.</p>
124+
</div>
125+
</div>
126+
127+
<div class="rg-slack-setup__step">
128+
<div class="rg-slack-setup__number">4</div>
129+
<div class="rg-slack-setup__content">
130+
<h3 class="rg-slack-setup__step-title">Add Configuration</h3>
131+
<p class="rg-slack-setup__step-text">Create <code>.codeGROOVE/discord.yaml</code> in your org with your server ID and user mappings.</p>
132+
</div>
133+
</div>
134+
</div>
135+
</div>
136+
</section>
137+
138+
<section class="rg-slack-config">
139+
<div class="rg-slack-config__container">
140+
<h2 class="rg-slack-config__title">Configuration</h2>
141+
<p class="rg-slack-config__description">Create <code>.codeGROOVE/discord.yaml</code> in your org:</p>
142+
<div class="rg-slack-config__code">
143+
<pre><code>global:
144+
guild_id: "1234567890123456789" # Your Discord server ID
145+
reminder_dm_delay: 65 # Minutes before DM (0 = disabled)
146+
147+
users:
148+
alice: "111111111111111111" # GitHub username → Discord user ID
149+
bob: "222222222222222222"
150+
# Unmapped users: bot attempts username match
151+
152+
channels:
153+
engineering: # Channel name
154+
repos:
155+
- backend
156+
- frontend
157+
- api
158+
159+
all-prs:
160+
repos:
161+
- "*" # Wildcard: all repos
162+
163+
staging:
164+
mute: true # Disable notifications</code></pre>
165+
</div>
166+
</div>
167+
</section>
168+
169+
<section class="rg-slack-commands">
170+
<div class="rg-slack-commands__container">
171+
<h2 class="rg-slack-commands__title">Slash Commands</h2>
172+
<div class="rg-slack-commands__grid">
173+
<div class="rg-slack-commands__item">
174+
<code class="rg-slack-commands__command">/goose status</code>
175+
<p class="rg-slack-commands__description">Show bot connection status</p>
176+
</div>
177+
<div class="rg-slack-commands__item">
178+
<code class="rg-slack-commands__command">/goose report</code>
179+
<p class="rg-slack-commands__description">Get your daily PR summary now</p>
180+
</div>
181+
<div class="rg-slack-commands__item">
182+
<code class="rg-slack-commands__command">/goose dashboard</code>
183+
<p class="rg-slack-commands__description">Open your PR dashboard</p>
184+
</div>
185+
<div class="rg-slack-commands__item">
186+
<code class="rg-slack-commands__command">/goose help</code>
187+
<p class="rg-slack-commands__description">Show available commands</p>
188+
</div>
189+
</div>
190+
</div>
191+
</section>
192+
193+
<section class="rg-slack-cta">
194+
<div class="rg-slack-cta__container">
195+
<div class="rg-slack-cta__box">
196+
<h2 class="rg-slack-cta__title">Want desktop notifications too?</h2>
197+
<p class="rg-slack-cta__text">The <a href="/reviewgoose/desktop">desktop app</a> gives you menubar notifications with honk sounds. Use both for complete coverage.</p>
198+
<a href="/reviewgoose/" class="rg-slack-cta__button">Back to reviewGOOSE</a>
199+
</div>
200+
</div>
201+
</section>

0 commit comments

Comments
 (0)