Update Getting Started guide #7035
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JustinBeckwith
approved these changes
Jul 26, 2024
valdotle
reviewed
Jul 26, 2024
| > Your token is used to authorize API requests and carry your app's permissions, so they are *highly* sensitive. Make sure to never share your token or check it into any kind of version control. | ||
| Some intents are [privileged](#DOCS_TOPICS_GATEWAY/privileged-intents), meaning they allow your app to access data that may be considered sensitive (like the contents of messages). Privileged intents appear and can be toggled on the **Bot** page in your app's settings. Standard, non-privileged intents don't require any additional permissions or configurations. | ||
| Back in your project folder, rename the `.sample.env` file to `.env`. `.env` is where we'll store all of your app's credentials. |
Contributor
There was a problem hiding this comment.
Suggested change
| Back in your project folder, rename the `.sample.env` file to `.env`. `.env` is where we'll store all of your app's credentials. | |
| Back in your project folder, rename the `.sample.env` file to `.env`. This is where we'll store all of your app's credentials. |
|
|
||
| See a list of all [OAuth2 scopes](#DOCS_TOPICS_OAUTH2/shared-resources-oauth2-scopes), or read more on [permissions](#DOCS_TOPICS_PERMISSIONS) in the documentation. | ||
| - Apps installed in a **[server context](#DOCS_RESOURCES_APPLICATION/server-context)** (server-installed apps) must be authorized by a server member with the `MANAGE_GUILD` permission, and are visible to all members of the server. | ||
| - Apps installed in a **[user context](#DOCS_RESOURCES_APPLICATION/user-context)** (user-installed apps) are visible only to the authorizing user, and therefore don't require any server-specific permissions. Apps installed to a user context are visible across all of the user's servers, DMs, and GDMs—however, they're limited to using commands. |
Contributor
There was a problem hiding this comment.
Maybe "Group DMs" would be a little more self-explanatory here...
| To make development a bit simpler, the app uses [discord-interactions](https://github.com/discord/discord-interactions-js), which provides types and helper functions. If you prefer to use other languages or libraries, check out the [Community Resources](#DOCS_TOPICS_COMMUNITY_RESOURCES) documentation. | ||
| On the **Installation** page in the **Default Install Settings** section: | ||
| - For **User Install**, add the `applications.commands` scope | ||
| - For **Guild Install**, add the `applications.commands` scope and `bot` scope. When you select `bot`, a new **Permissions** menu will appear to select the bot user's permissions. Select any permissions that you may want for your app—for now, I'll just select `Send Messages`. |
Contributor
There was a problem hiding this comment.
The guide alternates between "we" and "I" sometimes; sticking with either singular or plural would probably be a little more consistent (style-wise, not that it matters for the information conveyed)...
| ## Step 3: Handling interactivity | ||
|
|
||
| To enable your app to receive slash command requests (and other interactions), Discord needs a public URL to send them. This URL can be configured in your app's settings as **Interaction Endpoint URL**. | ||
| To enable your app to receive slash command and other interactions requests, Discord needs a public URL to send them. This URL can be configured in your app's settings as **Interaction Endpoint URL**. |
Contributor
There was a problem hiding this comment.
Suggested change
| To enable your app to receive slash command and other interactions requests, Discord needs a public URL to send them. This URL can be configured in your app's settings as **Interaction Endpoint URL**. | |
| To enable your app to receive slash command and other interactions' requests, Discord needs a public URL to send them. This URL can be configured in your app's settings as **Interaction Endpoint URL**. |
Co-authored-by: val.le <81811276+valdotle@users.noreply.github.com>
Co-authored-by: val.le <81811276+valdotle@users.noreply.github.com>
Co-authored-by: val.le <81811276+valdotle@users.noreply.github.com>
Co-authored-by: val.le <81811276+valdotle@users.noreply.github.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updates Getting Started guide with a few new things:
Also updates "Authorization Methods" -> "Installation Contexts" since that was updated in app's settings