docs: update Discord setup screenshots and simplify permissions guide#528
docs: update Discord setup screenshots and simplify permissions guide#528
Conversation
Replace outdated screenshots for the Discord channel setup guide: - Intents page: new screenshot showing Server Members Intent & Message Content Intent toggles - OAuth2 page: new screenshot showing Scopes (bot) & Bot Permissions (Administrator) - Generated URL: new screenshot showing the copy URL section Simplify the permissions step from two sub-steps (select 8 individual permissions) into one (select Administrator), and remove the now-unused step5-permissions.webp asset. Updates zh/en/ja docs accordingly. Made-with: Cursor
📝 WalkthroughWalkthroughThe Discord bot setup instructions across English, Japanese, and Chinese documentation were simplified. The OAuth2 configuration now requires selecting only the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Deploying nexu-docs with
|
| Latest commit: |
901e5da
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://d01dc502.nexu-docs.pages.dev |
| Branch Preview URL: | https://docs-update-discord-setup-sc.nexu-docs.pages.dev |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/en/guide/channels/discord.md`:
- Around line 38-40: The doc currently tells users to grant Administrator, but
the bot only needs granular permissions; update the Discord docs to replace
"Administrator" with the explicit permissions: Send Messages, Read Message
History, Embed Links, Attach Files, Add Reactions, and Use Slash Commands (match
the permissions configured in
apps/web/src/components/channel-setup/discord-setup-view.tsx), and ensure the
OAuth example/URL in the docs reflects the actual permissions bit used (or call
out that the authorization code uses permissions=8) and update the
screenshot/alt text if necessary so documentation and the code (permissions=8 /
discord-setup-view.tsx) are consistent.
In `@docs/ja/guide/channels/discord.md`:
- Around line 29-30: Update the Discord OAuth2 instructions to remove the
"Administrator" Bot Permission and instead instruct selecting only the minimal
permissions the bot needs (e.g., "View Channels", "Read Message History", "Send
Messages", and "Add Reactions" if applicable) where the current text says
"Scopes で `bot` を選択、Bot Permissions で `Administrator` を選択します" and the
accompanying image/step; replace that line and any equivalent phrasing across
all language versions of the docs so the guidance follows least-privilege
principles rather than recommending `Administrator`.
In `@docs/zh/guide/channels/discord.md`:
- Around line 38-40: The OAuth redirect URL in channels.tsx currently hardcodes
permissions=8 (Administrator); replace that with the minimal required permission
bitfield (4295084096) or compute it programmatically by OR-ing the permission
constants for Send Messages (2048), Read Message History (65536), Embed Links
(16384), Attach Files (32768), Add Reactions (64) and Use Slash Commands
(4294967296) when building the OAuth URL (the location that contains the
'permissions=8' string) — alternatively use Discord's permission calculator to
generate and insert the correct bitfield instead of 8.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: cefd7f99-8425-4138-936b-006b2006dfdb
📒 Files selected for processing (7)
docs/en/guide/channels/discord.mddocs/ja/guide/channels/discord.mddocs/public/assets/discord/step4-intents.webpdocs/public/assets/discord/step5-generated-url.webpdocs/public/assets/discord/step5-permissions.webpdocs/public/assets/discord/step5-scopes.webpdocs/zh/guide/channels/discord.md
Summary
Administrator,步骤数从 6 步精简为 5 步step5-permissions.webp图片资源Test plan
pnpm dev确认三个语言版本的 Discord 文档页面图片正常显示step5-permissions.webp不再被任何文档引用Made with Cursor
Summary by CodeRabbit
botscope and setting permissions toAdministratorinstead of granular selections. Guide steps were consolidated and renumbered for clarity.