Skip to content

Commit 57900b3

Browse files
GeniusTimoGeniusTimo
authored
Updated alert boxes (#7484)
1 parent 9275cb7 commit 57900b3

File tree

17 files changed

+70
-53
lines changed

17 files changed

+70
-53
lines changed

‎docs/activities/building-an-activity.mdx

+15-5
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,9 @@ With our project set up, let's create our app and configure the Activity. Create
112112
Enter a name for your app, select a development team, then press **Create**.
113113

114114
:::info
115-
**Development Team Access** <br />Launching a non-distributed Activity is limited to you or members of the developer team, so if you're collaborating with others during development, create a [developer team](https://discord.com/developers/teams) and set it to the owner when you create the app.
115+
**Development Team Access**
116+
117+
Launching a non-distributed Activity is limited to you or members of the developer team, so if you're collaborating with others during development, create a [developer team](https://discord.com/developers/teams) and set it to the owner when you create the app.
116118
:::
117119

118120
After you create your app, you'll land on the **General Overview** page of the app's settings, where you can update basic information about your app like its description and icon.
@@ -160,15 +162,19 @@ cp example.env .env
160162
```
161163

162164
:::warn
163-
**Secure Your Secrets**<br /> Your `DISCORD_CLIENT_SECRET` and `DISCORD_BOT_TOKEN` are *highly* sensitive secrets. Never share either secrets or check them into any kind of version control.
165+
**Secure Your Secrets**
166+
167+
Your `DISCORD_CLIENT_SECRET` and `DISCORD_BOT_TOKEN` are *highly* sensitive secrets. Never share either secrets or check them into any kind of version control.
164168
:::
165169

166170
Back in your app's settings, click on **OAuth2** on the sidebar:
167171
1. **Client ID**: Copy the value for Client ID and add it to your `.env` file as **`VITE_CLIENT_ID`**. This is the public ID that Discord associates with your app, and is almost always the same as your App ID.
168172
2. **Client Secret**: Copy the value for Client Secret and add it to your `.env` as **`DISCORD_CLIENT_SECRET`**. This is a private, sensitive identifier that your app will use to grant an OAuth2 `access_token`, and should never be shared or checked into version control.
169173

170174
:::info
171-
**Why is there a VITE_ prefix before our Client ID?**<br />Prefixing the `CLIENT_ID` environment variable with `VITE_` makes it accessible to our client-side code. This security measure ensures that only the variables you intend to be accessible in the browser are available, and all other environment variables remain private. You can read details in the [Vite documentation](https://vitejs.dev/guide/env-and-mode).
175+
**Why is there a VITE_ prefix before our Client ID?**
176+
177+
Prefixing the `CLIENT_ID` environment variable with `VITE_` makes it accessible to our client-side code. This security measure ensures that only the variables you intend to be accessible in the browser are available, and all other environment variables remain private. You can read details in the [Vite documentation](https://vitejs.dev/guide/env-and-mode).
172178
:::
173179

174180
<Collapsible title="Step 2 Checkpoint" icon="list" open>
@@ -239,7 +245,9 @@ document.querySelector('#app').innerHTML = `
239245
</Collapsible>
240246
241247
:::warn
242-
**Time to leave your browser behind**<br />Once you add the SDK to your app, you will **not** be able to view your app inside your web browser. In the next step, we will run your Activity inside of Discord. In the next step, we will go over how to view your app in Discord.
248+
**Time to leave your browser behind**
249+
250+
Once you add the SDK to your app, you will **not** be able to view your app inside your web browser. In the next step, we will run your Activity inside of Discord. In the next step, we will go over how to view your app in Discord.
243251
:::
244252
245253
<Collapsible title="Step 3 Checkpoint" icon="list" open>
@@ -336,7 +344,9 @@ Clicking on your app will launch your locally running app from inside Discord!
336344
![Running your activity](images/activities/start-activity.png)
337345
338346
:::info
339-
**Customizing your Activity** <br/> If you'd like to set images for your Activity, you can learn how to do that [here](/docs/activities/development-guides#setting-up-activity-metadata).
347+
**Customizing your Activity**
348+
349+
If you'd like to set images for your Activity, you can learn how to do that [here](/docs/activities/development-guides#setting-up-activity-metadata).
340350
:::
341351
342352
We're looking pretty good so far, but we haven't wired up any Discord functionality yet. Let's do that next.

‎docs/developer-tools/embedded-app-sdk.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1057,7 +1057,7 @@ No scopes required
10571057
### ENTITLEMENT_CREATE
10581058

10591059
:::preview
1060-
Coming soon! Not available during Developer Preview
1060+
Coming soon! Not available during Developer Preview
10611061
:::
10621062

10631063
## SDK Interfaces

‎docs/developer-tools/game-sdk.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33
# Game SDK
44

55
:::warn
6-
**The Game SDK has been archived.**<br />We recommend using the [Discord Social SDK](/docs/discord-social-sdk/overview) for new projects. <br />Existing projects using the Game SDK will continue to work, but we encourage you to migrate to the [Discord Social SDK](/docs/discord-social-sdk/overview) for new features and updates.
6+
**The Game SDK has been archived.**
7+
8+
We recommend using the [Discord Social SDK](/docs/discord-social-sdk/overview) for new projects.
9+
10+
Existing projects using the Game SDK will continue to work, but we encourage you to migrate to the [Discord Social SDK](/docs/discord-social-sdk/overview) for new features and updates.
711
:::
812

913
Welcome to the documentation for the Discord Game SDK! We're glad you made it. The Game SDK helps you develop your 3rd party game or app, and integrate it with Discord.

‎docs/discord-social-sdk/core-concepts.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ The following features are only fully unlocked when joining the closed beta:
4848
While these limited access features are available in the Discord Social SDK, their usage is capped with a rate limit. Please read our [documentation on rate limits](/docs/topics/rate-limits) to learn more.
4949

5050
:::preview
51-
To apply for full access to closed beta features or to reach out to Discord directly to discuss your game, please fill out [this form](https://discord.com/developers/social-sdk-closed-beta-access-request-form).
51+
To apply for full access to closed beta features or to reach out to Discord directly to discuss your game, please fill out [this form](https://discord.com/developers/social-sdk-closed-beta-access-request-form).
5252
:::
5353

5454
---
@@ -215,7 +215,7 @@ Some SDK features are currently available but have limited access. Those feature
215215
- `sdk.social_layer`
216216

217217
:::preview
218-
For more information about these features, please see [Core Concepts: Limited Access Features](/docs/discord-social-sdk/core-concepts#limited-access-features).
218+
For more information about these features, please see [Core Concepts: Limited Access Features](/docs/discord-social-sdk/core-concepts#limited-access-features).
219219
:::
220220

221221
The Social SDK provides two helper methods that you can use when setting up your OAuth2 flow:

‎docs/discord-social-sdk/getting-started/using-c++.mdx

+1-2
Original file line numberDiff line numberDiff line change
@@ -296,8 +296,7 @@ Most Discord features won't work until the status is [`Client::Status::Ready`].
296296
- The **status callback** tells you when you're connected and ready to use Discord features
297297

298298
:::info
299-
At this point, these callbacks **won't get called** since the client setup is not yet complete. However, very soon we
300-
will be using them to view debug information and see what our connection status is!
299+
At this point, these callbacks **won't get called** since the client setup is not yet complete. However, very soon we will be using them to view debug information and see what our connection status is!
301300
:::
302301

303302
To get to a [`Client::Status::Ready`] state, we need to authenticate with Discord. We'll do that shortly.

‎docs/discord-social-sdk/overview.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Start integrating the SDK into your game with our getting started guides, design
4343
Discord Social SDK features for text and voice communication are available but have limited access.
4444

4545
:::preview
46-
For more information on how to access these features, please see [Core Concepts: Limited Access Features](/docs/discord-social-sdk/core-concepts#limited-access-features).
46+
For more information on how to access these features, please see [Core Concepts: Limited Access Features](/docs/discord-social-sdk/core-concepts#limited-access-features).
4747
:::
4848

4949
---

‎docs/discord-social-sdk/partials/callouts/limited-access.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
:::preview
2-
This feature is currently available with [limited access](/docs/discord-social-sdk/core-concepts#limited-access-features). To apply for full access to closed beta features, or to reach out to Discord directly to discuss your game, please fill out [this form](https://discord.com/developers/social-sdk-closed-beta-access-request-form).
2+
This feature is currently available with [limited access](/docs/discord-social-sdk/core-concepts#limited-access-features). To apply for full access to closed beta features, or to reach out to Discord directly to discuss your game, please fill out [this form](https://discord.com/developers/social-sdk-closed-beta-access-request-form).
33
:::

‎docs/interactions/application-commands.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ Slash commands—the `CHAT_INPUT` type—are a type of application command. They
428428
Slash commands can also have groups and subcommands to further organize commands. More on those later.
429429

430430
:::warn
431-
Slash commands can have a maximum of 8000 characters for combined name, description, and value properties for each command, its options (including subcommands and groups), and choices. When [localization fields](/docs/interactions/application-commands#localization) are present, only the longest localization for each field (including the default value) is counted towards the size limit.
431+
Slash commands can have a maximum of 8000 characters for combined name, description, and value properties for each command, its options (including subcommands and groups), and choices. When [localization fields](/docs/interactions/application-commands#localization) are present, only the longest localization for each field (including the default value) is counted towards the size limit.
432432
:::
433433

434434

@@ -1096,7 +1096,7 @@ An application command furnished with localizations might look like this:
10961096
For application commands, there are built-in fallbacks in case a user's locale isn't present in the localizations. If the fallback locale is also missing, it will use the default.
10971097

10981098
:::warn
1099-
You should make sure to include your default value in its proper locale key, otherwise it may use a fallback value unexpectedly. For example, if your default value is `en-US`, but you don't specify the `en-US` value in your localizations, users with `en-US` selected will see the `en-GB` value if it's specified. For example, if you have a command with the default name "color", and your localizations specify only the `en-GB` value as "colour", users in the `en-US` locale will see "colour" because the `en-US` key is missing.
1099+
You should make sure to include your default value in its proper locale key, otherwise it may use a fallback value unexpectedly. For example, if your default value is `en-US`, but you don't specify the `en-US` value in your localizations, users with `en-US` selected will see the `en-GB` value if it's specified. For example, if you have a command with the default name "color", and your localizations specify only the `en-GB` value as "colour", users in the `en-US` locale will see "colour" because the `en-US` key is missing.
11001100
:::
11011101

11021102
| Locale | Fallback |

‎docs/monetization/managing-skus.mdx

+4-2
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,10 @@ Subscription SKUs are automatically charged each month unless canceled. Changing
6767
To set an icon using a standard Unicode emoji, enter the emoji in the `Unicode Emoji or Custom Emoji Name` field.
6868

6969
:::info
70-
Using an emoji keyboard can make it easier to pick an icon to display alongside your SKU benefit.
71-
MacOS: `control + command + space bar`
70+
Using an emoji keyboard can make it easier to pick an icon to display alongside your SKU benefit.
71+
72+
MacOS: `control + command + space bar`
73+
7274
Windows: `Windows + .`
7375
:::
7476

‎docs/reference.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -415,7 +415,7 @@ The `attachments` JSON parameter includes all files that will be appended to the
415415

416416
###### Example Request Bodies (multipart/form-data)
417417

418-
Note that these examples are small sections of an HTTP request to demonstrate behaviour of this endpoint - client libraries will set their own form boundaries (`boundary` is just an example). For more information, refer to the [multipart/form-data spec](https://tools.ietf.org/html/rfc7578#section-4).
418+
Note that these examples are small sections of an HTTP request to demonstrate behavior of this endpoint - client libraries will set their own form boundaries (`boundary` is just an example). For more information, refer to the [multipart/form-data spec](https://tools.ietf.org/html/rfc7578#section-4).
419419

420420
This example demonstrates usage of the endpoint *without* `payload_json`.
421421

‎docs/resources/emoji.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,13 @@ The `user` field of an app emoji object represents the team member that uploaded
6868

6969
###### Custom Emoji Examples
7070

71-
>info
72-
>In `MESSAGE_REACTION_ADD`, `MESSAGE_REACTION_REMOVE` and `MESSAGE_REACTION_REMOVE_EMOJI` gateway events `animated` will be returned for animated emoji.
71+
:::info
72+
In `MESSAGE_REACTION_ADD`, `MESSAGE_REACTION_REMOVE` and `MESSAGE_REACTION_REMOVE_EMOJI` gateway events `animated` will be returned for animated emoji.
73+
:::
7374

74-
>info
75-
>In `MESSAGE_REACTION_ADD` and `MESSAGE_REACTION_REMOVE` gateway events `name` may be `null` when custom emoji data is not available (for example, if it was deleted from the guild).
75+
:::info
76+
In `MESSAGE_REACTION_ADD` and `MESSAGE_REACTION_REMOVE` gateway events `name` may be `null` when custom emoji data is not available (for example, if it was deleted from the guild).
77+
:::
7678

7779
```json
7880
{

‎docs/resources/message.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ An app will receive empty values in the `content`, `embeds`, `attachments`, and
7070
###### Message Types
7171

7272
:::warn
73-
Type `19` and `20` are only available in API v8 and above. In v6, they are represented as type `0`. Additionally, type `21` is only available in API v9 and above.
73+
Type `19` and `20` are only available in API v8 and above. In v6, they are represented as type `0`. Additionally, type `21` is only available in API v9 and above.
7474
:::
7575

7676
| Type | Value | Deletable |
@@ -313,7 +313,7 @@ Information about the call in a private channel.
313313
| guild_id? | snowflake | id of the originating message's guild |
314314
| fail_if_not_exists? | boolean | when sending, whether to error if the referenced message doesn't exist instead of sending as a normal (non-reply) message, default true |
315315

316-
\* If `type` is unset, `DEFAULT` can be assumed in order to match the behaviour before message reference had types.
316+
\* If `type` is unset, `DEFAULT` can be assumed in order to match the behavior before message reference had types.
317317
In future API versions this will become a required field.
318318

319319
\*\* `channel_id` is optional when creating a reply, but will always be present when receiving an event/response that includes this data model. **Required for forwards.**

‎docs/rich-presence/overview.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,11 @@ After a user joins an Activity, Rich Presence can be used to dynamically show da
4343
### Game SDK
4444

4545
:::warn
46-
**The Game SDK has been archived.**<br />We recommend using the [Discord Social SDK](/docs/discord-social-sdk/overview) for new projects. <br />Existing projects using the Game SDK will continue to work, but we encourage you to migrate to the [Discord Social SDK](/docs/discord-social-sdk/overview) for new features and updates.
46+
**The Game SDK has been archived.**
47+
48+
We recommend using the [Discord Social SDK](/docs/discord-social-sdk/overview) for new projects.
49+
50+
Existing projects using the Game SDK will continue to work, but we encourage you to migrate to the [Discord Social SDK](/docs/discord-social-sdk/overview) for new features and updates.
4751
:::
4852

4953
The [Game SDK](/docs/developer-tools/game-sdk) makes it easier to build 3rd party games and integrate them with Discord. While many features of the Game SDK are deprecated, it can still be used for a few use cases (like integrating Rich Presence!).

‎docs/rich-presence/using-with-the-game-sdk.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,11 @@ sidebar_label: Using with the Game SDK
55
# Using Rich Presence with the Game SDK
66

77
:::warn
8-
**The Game SDK has been archived.**<br />We recommend using the [Discord Social SDK](/docs/discord-social-sdk/overview) for new projects. <br />Existing projects using the Game SDK will continue to work, but we encourage you to migrate to the [Discord Social SDK](/docs/discord-social-sdk/overview) for new features and updates.
8+
**The Game SDK has been archived.**
9+
10+
We recommend using the [Discord Social SDK](/docs/discord-social-sdk/overview) for new projects.
11+
12+
Existing projects using the Game SDK will continue to work, but we encourage you to migrate to the [Discord Social SDK](/docs/discord-social-sdk/overview) for new features and updates.
913
:::
1014

1115
The [Game SDK](/docs/developer-tools/game-sdk) helps you build 3rd party games and integrate them with Discord. One of its specialties is making it easy to bring your game's data to Discord using [Rich Presence](/docs/rich-presence/overview), which this guide will cover.

‎docs/topics/oauth2.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,7 @@ These are a list of all the OAuth2 scopes that Discord supports. Some scopes req
5454
| webhook.incoming | this generates a webhook that is returned in the oauth token response for authorization code grants |
5555

5656
:::info
57-
In order to add a user to a guild, your bot has to already belong to that guild.
58-
`role_connections.write` cannot be used with the [Implicit grant type](/docs/topics/oauth2#implicit-grant).
57+
In order to add a user to a guild, your bot has to already belong to that guild. `role_connections.write` cannot be used with the [Implicit grant type](/docs/topics/oauth2#implicit-grant).
5958
:::
6059

6160
## State and Security

‎docs/topics/rpc.md

+2-12
Original file line numberDiff line numberDiff line change
@@ -485,12 +485,7 @@ Used to change voice settings of users in voice channels
485485
| mute? | boolean | set the mute state of the user |
486486

487487
:::info
488-
In the current release, we only support a single modifier of voice settings at a time over RPC.
489-
If an app changes voice settings, it will lock voice settings so that other apps connected simultaneously
490-
lose the ability to change voice settings. Settings reset to what they were before being changed after the
491-
controlling app disconnects. When an app that has previously set voice settings connects, the client will swap
492-
to that app's configured voice settings and lock voice settings again. This is a temporary situation that will
493-
be changed in the future.
488+
In the current release, we only support a single modifier of voice settings at a time over RPC. If an app changes voice settings, it will lock voice settings so that other apps connected simultaneously lose the ability to change voice settings. Settings reset to what they were before being changed after the controlling app disconnects. When an app that has previously set voice settings connects, the client will swap to that app's configured voice settings and lock voice settings again. This is a temporary situation that will be changed in the future.
494489
:::
495490

496491
###### Pan Object
@@ -739,12 +734,7 @@ Used to join and leave text channels, group dms, or dms. Returns the [Get Channe
739734
#### SET_VOICE_SETTINGS
740735

741736
:::info
742-
In the current release, we only support a single modifier of voice settings at a time over RPC.
743-
If an app changes voice settings, it will lock voice settings so that other apps connected simultaneously
744-
lose the ability to change voice settings. Settings reset to what they were before being changed after the
745-
controlling app disconnects. When an app that has previously set voice settings connects, the client will swap
746-
to that app's configured voice settings and lock voice settings again. This is a temporary situation that will
747-
be changed in the future.
737+
In the current release, we only support a single modifier of voice settings at a time over RPC. If an app changes voice settings, it will lock voice settings so that other apps connected simultaneously lose the ability to change voice settings. Settings reset to what they were before being changed after the controlling app disconnects. When an app that has previously set voice settings connects, the client will swap to that app's configured voice settings and lock voice settings again. This is a temporary situation that will be changed in the future.
748738
:::
749739

750740
When setting voice settings, all fields are optional. Only passed fields are updated.

0 commit comments

Comments
 (0)