use directives for help messages by JustinBeckwith · Pull Request #7482 · discord/discord-api-docs

JustinBeckwith · 2025-04-20T15:44:58Z

No description provided.

GeniusTimo

The following alert boxes were missed because they are not formatted correctly (however, they are currently working)

discord-api-docs/docs/resources/emoji.md

Lines 71 to 75 in bc7a0a5

    
           >info 
        
           >In `MESSAGE_REACTION_ADD`, `MESSAGE_REACTION_REMOVE` and `MESSAGE_REACTION_REMOVE_EMOJI` gateway events `animated` will be returned for animated emoji. 
        
           >info 
        
           >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).

discord-api-docs/docs/topics/voice-connections.mdx

Lines 11 to 12 in bc7a0a5

    
           >warn 
        
           >Versions below 4 as well as the default version behaviour will be discontinued as of November 18th, 2024. Connections without a version or with a version less than version 4 will be rejected as of this date.

discord-api-docs/docs/topics/voice-connections.mdx

Lines 214 to 215 in bc7a0a5

    
           >info 
        
           >You are not immediately required to support the E2EE protocol, as calls will automatically upgrade/downgrade to/from E2EE depending on the support of clients in the call. Non-E2EE connections to voice in DMs, Group DMs, voice channels, and Go Live streams will soon be deprecated and will be discontinued (after at least a six month deprecation window).

discord-api-docs/docs/topics/voice-connections.mdx

Lines 239 to 240 in bc7a0a5

    
           >warn 
        
           >Clients must retain backwards-compatibility of any non-discontinued DAVE protocol versions. The voice gateway selects the lowest shared protocol version for the call.

discord-api-docs/docs/topics/voice-connections.mdx

Lines 400 to 404 in bc7a0a5

    
           >warn  
        
           >The deprecated encryption modes above will be discontinued as of November 18th, 2024. As of this date the voice gateway will not allow you to connect with one of the deprecated encryption modes. 
        
           >warn 
        
           >The nonce has to be stripped from the payload before encrypting and before decrypting the audio data

Sign in to view

+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!


Sign in to view

-> 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.
+:::warn
+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.


Sign in to view

-> info
-> **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.
+:::info
+**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.


Sign in to view

-> info
-> **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).
+:::info
+**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).


Sign in to view

-> warn
-> **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.
+:::warn
+**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.


Sign in to view

-> preview
-> Coming soon! Not available during Developer Preview
+:::preview
+ Coming soon! Not available during Developer Preview


Sign in to view

-> preview
-> 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).
+:::preview
+ 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).


Sign in to view

-> preview
-> 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).
+:::preview
+ 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).


Sign in to view

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


Sign in to view

-> preview
-> 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).
+:::preview
+ 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).


appellation

seems reasonable pending suggestions from @GeniusTimo

JustinBeckwith · 2025-04-21T17:54:08Z

Gonna come hit cleanup in a followup PR, this one was toooooo big

use directives for help messages

bc7a0a5

JustinBeckwith requested a review from a team as a code owner April 20, 2025 15:44

JustinBeckwith requested review from anthonydiscord and removed request for a team April 20, 2025 15:44

GeniusTimo reviewed Apr 21, 2025

View reviewed changes

JustinBeckwith requested a review from appellation April 21, 2025 16:14

appellation approved these changes Apr 21, 2025

View reviewed changes

anthonydiscord approved these changes Apr 21, 2025

View reviewed changes

JustinBeckwith merged commit 9275cb7 into main Apr 21, 2025
4 checks passed

JustinBeckwith deleted the directives branch April 21, 2025 17:53

GeniusTimo added a commit to GeniusTimo/discord-api-docs that referenced this pull request Apr 21, 2025

Resolved my review comments from PR discord#7482

23b7642

This was referenced Apr 21, 2025

Updated alert boxes #7484

Merged

Updated contributing guidelines for alert boxes #7489

Merged

mazylol pushed a commit to mazylol/discord-api-docs that referenced this pull request Jul 3, 2025

use directives for help messages (discord#7482)

f39fb0f

	>info
	>In `MESSAGE_REACTION_ADD`, `MESSAGE_REACTION_REMOVE` and `MESSAGE_REACTION_REMOVE_EMOJI` gateway events `animated` will be returned for animated emoji.

	>info
	>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).

	>warn
	>Versions below 4 as well as the default version behaviour will be discontinued as of November 18th, 2024. Connections without a version or with a version less than version 4 will be rejected as of this date.

	>info
	>You are not immediately required to support the E2EE protocol, as calls will automatically upgrade/downgrade to/from E2EE depending on the support of clients in the call. Non-E2EE connections to voice in DMs, Group DMs, voice channels, and Go Live streams will soon be deprecated and will be discontinued (after at least a six month deprecation window).

	>warn
	>Clients must retain backwards-compatibility of any non-discontinued DAVE protocol versions. The voice gateway selects the lowest shared protocol version for the call.

	>warn
	>The deprecated encryption modes above will be discontinued as of November 18th, 2024. As of this date the voice gateway will not allow you to connect with one of the deprecated encryption modes.

	>warn
	>The nonce has to be stripped from the payload before encrypting and before decrypting the audio data

		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!

Conversation

JustinBeckwith commented Apr 20, 2025

Uh oh!

GeniusTimo left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

This comment was marked as resolved.

Uh oh!

appellation left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

JustinBeckwith commented Apr 21, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants