Skip to content

docs: update Discord setup screenshots and simplify permissions guide#528

Merged
lefarcen merged 1 commit intomainfrom
docs/update-discord-setup-screenshots
Mar 25, 2026
Merged

docs: update Discord setup screenshots and simplify permissions guide#528
lefarcen merged 1 commit intomainfrom
docs/update-discord-setup-screenshots

Conversation

@qiongyu1999
Copy link
Copy Markdown
Collaborator

@qiongyu1999 qiongyu1999 commented Mar 25, 2026

Summary

  • 替换 Discord 渠道配置文档中的 3 张截图:Intents 页面、OAuth2 Scopes/Permissions 页面、Generated URL 页面
  • 简化权限配置步骤:将原来分两步选择 8 项细粒度权限合并为一步勾选 Administrator,步骤数从 6 步精简为 5 步
  • 删除不再使用的 step5-permissions.webp 图片资源
  • 中文 / 英文 / 日文三个语言版本同步更新

Test plan

  • 本地运行 pnpm dev 确认三个语言版本的 Discord 文档页面图片正常显示
  • 确认步骤编号连续无跳号
  • 确认删除的 step5-permissions.webp 不再被任何文档引用

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Simplified Discord bot setup guide across all language versions. The OAuth2 configuration now requires selecting only the bot scope and setting permissions to Administrator instead of granular selections. Guide steps were consolidated and renumbered for clarity.

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
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 25, 2026

📝 Walkthrough

Walkthrough

The Discord bot setup instructions across English, Japanese, and Chinese documentation were simplified. The OAuth2 configuration now requires selecting only the bot scope and Administrator permission instead of multiple granular scopes and permissions, reducing the step count and consolidating the setup process.

Changes

Cohort / File(s) Summary
Discord Setup Documentation
docs/en/guide/channels/discord.md, docs/ja/guide/channels/discord.md, docs/zh/guide/channels/discord.md
Simplified OAuth2 permission configuration by consolidating scope selection to only bot and using Administrator permission instead of granular permissions. Reduced intermediate steps and updated step numbering across all language versions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A hop and a skip through the Discord mine,
Where setup steps now align in time!
From many scopes to one so sweet,
Administrator makes the config complete.
Simpler paths for friends to find—
Less confusion left behind! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description partially follows the template but is missing key required sections. It lacks 'What', 'Why', 'How', and 'Affected areas' sections that are present in the template. Restructure the description using the template format: add 'What', 'Why', 'How' sections, check appropriate 'Affected areas', complete the checklist, and organize content accordingly.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title directly describes the main changes: updating Discord screenshots and simplifying the permissions guide, which aligns with the primary modifications across all three language versions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/update-discord-setup-screenshots

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

Deploying nexu-docs with  Cloudflare Pages  Cloudflare Pages

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

View logs

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 262fc9b and 901e5da.

📒 Files selected for processing (7)
  • docs/en/guide/channels/discord.md
  • docs/ja/guide/channels/discord.md
  • docs/public/assets/discord/step4-intents.webp
  • docs/public/assets/discord/step5-generated-url.webp
  • docs/public/assets/discord/step5-permissions.webp
  • docs/public/assets/discord/step5-scopes.webp
  • docs/zh/guide/channels/discord.md

Comment thread docs/en/guide/channels/discord.md
Comment thread docs/ja/guide/channels/discord.md
Comment thread docs/zh/guide/channels/discord.md
@lefarcen lefarcen merged commit 6a41469 into main Mar 25, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants