Add guide for finding Discord IDs and mentions#98
Conversation
This document provides a guide on how to find Discord IDs and mention entities using their IDs, including steps to enable Developer Mode and copy IDs for users, channels, roles, messages, and servers.
There was a problem hiding this comment.
Pull request overview
This PR adds a new documentation guide that explains how to find Discord IDs and use mention syntax in SCNX. The guide covers enabling Developer Mode, copying IDs for various Discord entities (users, channels, roles, messages, servers), and using mention syntax with proper formatting examples.
Changes:
- Added comprehensive documentation file
docs/discord-ids.mdwith step-by-step instructions - Included screenshot assets to visually support the documentation
- Provided reference to timestamp formatting in another documentation file
Reviewed changes
Copilot reviewed 1 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/discord-ids.md | New guide explaining how to enable Developer Mode, copy Discord IDs, and use mention syntax for various Discord elements |
| docs/assets/discord-ids/en/scnx-mention-helper.png | Screenshot showing the SCNX mention helper button in the message editor |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Deploying scnx-docs with
|
| Latest commit: |
b89a4f2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://59f7fe33.scnx-docs.pages.dev |
| Branch Preview URL: | https://discord-ids.scnx-docs.pages.dev |
SCDerox
left a comment
SCDerox
left a comment
There was a problem hiding this comment.
Also missing is a German translation.
| Once Developer Mode is active, you can right-click almost anything in Discord to get its unique ID. | ||
| * **Users:** Right-click a user's name or avatar and select **Copy User ID**. | ||
| * **Channels:** Right-click a channel name and select **Copy Channel ID**. | ||
| * **Roles:** Go to Server Settings > Roles, right-click the role name, and select **Copy Role ID**. | ||
| * **Messages:** Right-click a message and select **Copy Message ID**. | ||
| * **Servers:** Right-click the server's icon and select **Copy Server ID**. |
There was a problem hiding this comment.
While this works, I suggest adding screenshots for each and lengthening them sections. This guide is for novice users and this might need visiual reinforcment.
Example:
### Copy User IDs
Every user on Discord has one unique ID that is used by bots. To copy it, ensure you have the developer mode enabled (link).
To copy it, do the following
1. Rightclick on the user
2. Select Copy User-ID
On mobile: [mobile specifc]
[Screenshot showing all steps clearly with sign-posting]
| If you want to include dynamic time displays, Discord uses a special Unix-Timestamp format. | ||
| You can find a detailed guide [here](@site/docs/discord-formatting.md#timestamps). |
There was a problem hiding this comment.
This should be longer for SEO purposes, include examples and screenshots
| To configure advanced features in SCNX, you sometimes need specific Discord IDs. This guide will show you how to find them and how to mention entities using their ID. | ||
|
|
||
| ## 1. Enable Discord Developer Mode | ||
| Before you can copy IDs, you must enable Developer Mode in your Discord client. |
There was a problem hiding this comment.
| Before you can copy IDs, you must enable Developer Mode in your Discord client. | |
| Before you can copy IDs, you need to enable the Developer Mode in your Discord client. |
| @@ -0,0 +1,39 @@ | |||
| # Discord IDs & Mentions | |||
|
|
|||
| To configure advanced features in SCNX, you sometimes need specific Discord IDs. This guide will show you how to find them and how to mention entities using their ID. | |||
There was a problem hiding this comment.
| To configure advanced features in SCNX, you sometimes need specific Discord IDs. This guide will show you how to find them and how to mention entities using their ID. | |
| To configure advanced features on SCNX, you sometimes need specific Discord IDs. This guide will show you how to find them and how to mention entities using their ID. |
maybe add additional content and context for SEO
| * **Servers:** Right-click the server's icon and select **Copy Server ID**. | ||
|
|
||
| ## 3. Mentioning Elements via ID | ||
| Sometimes you need to mention an element in a bot response or a message. Use the following syntax: |
There was a problem hiding this comment.
This is very unclear (e.g. when is this needed? can this be done in any message?). Make this longer for SEO purposes.
| Sometimes you need to mention an element in a bot response or a message. Use the following syntax: | ||
|
|
||
| :::info Mention-Helper in SCNX | ||
| In the SCNX Message-Editor, you often don't necessarily have to type the syntax manually. You can simply click the **"@" button** above the text field to easily select and insert channels or roles. |
There was a problem hiding this comment.
| In the SCNX Message-Editor, you often don't necessarily have to type the syntax manually. You can simply click the **"@" button** above the text field to easily select and insert channels or roles. | |
| In the SCNX Message-Editor, you often don't have to type the syntax manually. You can simply click the **"@" button** above the text field to easily select and insert channel or role mentions. |
|
|
||
| | Entity | Syntax | Example | | ||
| | :--- | :--- | :--- | | ||
| | **User** | `<@USERID>` | `<@123456789>` | |
There was a problem hiding this comment.
Ids are usually longer, this should be made clear, e.g. by using a real id. I also suggest adding a "preview" column to the table
2 participants
Type of PR
Checks
If you have changed the content (/ meaning) of an original file, please confirm:
Notes
Please enter additional information here.