fix(docs): update links to API docs after migration (#1502)

shiftinv · web-flow · commit d9e43a703b81 · 2026-02-19T17:34:14.000+01:00
diff --git a/changelog/1502.doc.rst b/changelog/1502.doc.rst
@@ -0,0 +1 @@
+Update links/references to Discord API docs.
diff --git a/disnake/app_commands.py b/disnake/app_commands.py
@@ -85,7 +85,7 @@ def application_command_factory(data: ApplicationCommandPayload) -> APIApplicati
 
 def _validate_name(name: str) -> None:
     # used for slash command names and option names
-    # see https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-naming
+    # see https://docs.discord.com/developers/interactions/application-commands#application-command-object-application-command-naming
 
     if not isinstance(name, str):
         msg = f"Slash command name and option names must be an instance of class 'str', received '{name.__class__}'"
@@ -498,7 +498,7 @@ class ApplicationCommand(ABC):  # noqa: B024  # this will get refactored eventua
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
         Defaults to ``False``.
 
         .. versionadded:: 2.8
@@ -771,7 +771,7 @@ class UserCommand(ApplicationCommand):
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
         Defaults to ``False``.
 
         .. versionadded:: 2.8
@@ -829,7 +829,7 @@ class APIUserCommand(UserCommand, _APIApplicationCommandMixin):
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
 
         .. versionadded:: 2.8
 
@@ -900,7 +900,7 @@ class MessageCommand(ApplicationCommand):
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
         Defaults to ``False``.
 
         .. versionadded:: 2.8
@@ -958,7 +958,7 @@ class APIMessageCommand(MessageCommand, _APIApplicationCommandMixin):
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
 
         .. versionadded:: 2.8
 
@@ -1036,7 +1036,7 @@ class SlashCommand(ApplicationCommand):
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
         Defaults to ``False``.
 
         .. versionadded:: 2.8
@@ -1177,7 +1177,7 @@ class APISlashCommand(SlashCommand, _APIApplicationCommandMixin):
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
 
         .. versionadded:: 2.8
 
diff --git a/disnake/appinfo.py b/disnake/appinfo.py
@@ -192,7 +192,7 @@ class AppInfo:
         A list of RPC origin URLs, if RPC is enabled.
     verify_key: :class:`str`
         The hex encoded key for verification in interactions and the
-        GameSDK's :ddocs:`GetTicket <game-sdk/applications#getticket>`.
+        GameSDK's `GetTicket <https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Applications.md#getticket>`_.
 
         .. versionadded:: 1.3
 
@@ -540,7 +540,7 @@ async def edit(
         event_webhooks_status: :class:`ApplicationEventWebhookStatus`
             The application's event webhooks status.
         event_webhooks_types: :class:`list`\[:class:`str`] | :data:`None`
-            The application's event webhook types. See `webhook event types <https://discord.com/developers/docs/events/webhook-events#event-types>`_
+            The application's event webhook types. See :ddocs:`webhook event types <events/webhook-events#event-types>`
             for a list of valid events.
 
         Raises
@@ -662,7 +662,7 @@ class PartialAppInfo:
         A list of RPC origin URLs, if RPC is enabled.
     verify_key: :class:`str`
         The hex encoded key for verification in interactions and the
-        GameSDK's :ddocs:`GetTicket <game-sdk/applications#getticket>`.
+        GameSDK's `GetTicket <https://github.com/discord/discord-api-docs/blob/legacy-gamesdk/docs/game_sdk/Applications.md#getticket>`_.
     terms_of_service_url: :class:`str` | :data:`None`
         The application's terms of service URL, if set.
     privacy_policy_url: :class:`str` | :data:`None`
diff --git a/disnake/embeds.py b/disnake/embeds.py
@@ -151,7 +151,7 @@ class Embed:
     type: :class:`str` | :data:`None`
         The type of embed. Usually "rich".
         Possible strings for embed types can be found on Discord's
-        :ddocs:`api-docs <resources/channel#embed-object-embed-types>`.
+        :ddocs:`api-docs <resources/message#embed-object-embed-types>`.
     description: :class:`str` | :data:`None`
         The description of the embed.
     url: :class:`str` | :data:`None`
@@ -239,7 +239,7 @@ def from_dict(cls, data: EmbedData) -> Self:
         format that Discord expects it to be in.
 
         You can find out about this format in the
-        :ddocs:`official Discord documentation <resources/channel#embed-object>`.
+        :ddocs:`official Discord documentation <resources/message#embed-object>`.
 
         Parameters
         ----------
diff --git a/disnake/enums.py b/disnake/enums.py
@@ -1588,7 +1588,7 @@ def __str__(self) -> str:
         return self.value
 
 
-# reference: https://discord.com/developers/docs/reference#locales
+# reference: https://docs.discord.com/developers/reference#locales
 class Locale(Enum):
     """Represents supported locales by Discord.
 
diff --git a/disnake/errors.py b/disnake/errors.py
@@ -224,7 +224,7 @@ class ConnectionClosed(ClientException):
         The shard ID that got closed if applicable.
     """
 
-    # https://discord.com/developers/docs/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes
+    # https://docs.discord.com/developers/topics/opcodes-and-status-codes#gateway-gateway-close-event-codes
     GATEWAY_CLOSE_EVENT_REASONS: ClassVar[Mapping[int, str]] = {
         4000: "Unknown error",
         4001: "Unknown opcode",
@@ -242,7 +242,7 @@ class ConnectionClosed(ClientException):
         4014: "Disallowed intents - you tried to specify an intent that you have not enabled or are not approved for.",
     }
 
-    # https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes
+    # https://docs.discord.com/developers/topics/opcodes-and-status-codes#voice-voice-close-event-codes
     GATEWAY_VOICE_CLOSE_EVENT_REASONS: ClassVar[Mapping[int, str]] = {
         **GATEWAY_CLOSE_EVENT_REASONS,
         4002: "Failed to decode payload",
diff --git a/disnake/ext/commands/ctx_menus_core.py b/disnake/ext/commands/ctx_menus_core.py
@@ -293,7 +293,7 @@ def user_command(
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
         Defaults to ``False``.
 
         .. versionadded:: 2.8
@@ -404,7 +404,7 @@ def message_command(
         .. versionadded:: 2.5
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
         Defaults to ``False``.
 
         .. versionadded:: 2.8
diff --git a/disnake/ext/commands/interaction_bot_base.py b/disnake/ext/commands/interaction_bot_base.py
@@ -546,7 +546,7 @@ def slash_command(
             .. versionadded:: 2.5
 
         nsfw: :class:`bool`
-            Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+            Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
             Defaults to ``False``.
 
             .. versionadded:: 2.8
@@ -656,7 +656,7 @@ def user_command(
             .. versionadded:: 2.5
 
         nsfw: :class:`bool`
-            Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+            Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
             Defaults to ``False``.
 
             .. versionadded:: 2.8
@@ -759,7 +759,7 @@ def message_command(
             .. versionadded:: 2.5
 
         nsfw: :class:`bool`
-            Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+            Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
             Defaults to ``False``.
 
             .. versionadded:: 2.8
diff --git a/disnake/ext/commands/slash_core.py b/disnake/ext/commands/slash_core.py
@@ -825,7 +825,7 @@ def slash_command(
             Added support for localizations.
 
     nsfw: :class:`bool`
-        Whether this command is :ddocs:`age-restricted <interactions/application-commands#agerestricted-commands>`.
+        Whether this command is :ddocs:`age-restricted <interactions/application-commands#age-restricted-commands>`.
         Defaults to ``False``.
 
         .. versionadded:: 2.8
diff --git a/disnake/http.py b/disnake/http.py
@@ -134,7 +134,7 @@ def set_attachments(payload: dict[str, Any], files: Sequence[File]) -> None:
 
 def to_multipart(payload: dict[str, Any], files: Sequence[File]) -> list[dict[str, Any]]:
     """Converts the payload and list of files to a multipart payload,
-    as specified by https://discord.com/developers/docs/reference#uploading-files
+    as specified by https://docs.discord.com/developers/reference#uploading-files
     """
     multipart: list[dict[str, Any]] = []
     for index, file in enumerate(files):
diff --git a/disnake/poll.py b/disnake/poll.py
@@ -363,7 +363,7 @@ def from_dict(
             poll.duration = utils.parse_time(expiry) - utils.snowflake_time(poll.message.id)
         else:
             # future support for non-expiring polls
-            # read the foot note https://discord.com/developers/docs/resources/poll#poll-object-poll-object-structure
+            # read the foot note https://docs.discord.com/developers/resources/poll#poll-object-poll-object-structure
             poll.duration = None
 
         if results := data.get("results"):
diff --git a/disnake/raw_models.py b/disnake/raw_models.py
@@ -128,7 +128,7 @@ class RawMessageUpdateEvent(_RawReprMixin):
         .. versionadded:: 1.7
 
     data: :class:`dict`
-        The raw data given by the :ddocs:`gateway <topics/gateway-events#message-update>`.
+        The raw data given by the :ddocs:`gateway <events/gateway-events#message-update>`.
     cached_message: :class:`Message` | :data:`None`
         The cached message, if found in the internal message cache. Represents the message before
         it is modified by the data in :attr:`RawMessageUpdateEvent.data`.
@@ -497,7 +497,7 @@ class RawPresenceUpdateEvent(_RawReprMixin):
     guild_id: :class:`int`
         The ID of the guild where the user's presence changed.
     data: :class:`dict`
-        The raw data given by the :ddocs:`gateway <topics/gateway-events#presence-update>`.
+        The raw data given by the :ddocs:`gateway <events/gateway-events#presence-update>`.
     """
 
     __slots__ = (
diff --git a/disnake/state.py b/disnake/state.py
@@ -929,7 +929,7 @@ def parse_message_reaction_remove(self, data: gateway.MessageReactionRemoveEvent
             id=emoji_id,
             animated=emoji.get("animated", False),
             # may be `None` in gateway events if custom emoji data isn't available anymore
-            # https://discord.com/developers/docs/resources/emoji#emoji-object-custom-emoji-examples
+            # https://docs.discord.com/developers/resources/emoji#emoji-object-custom-emoji-examples
             name=emoji["name"],  # pyright: ignore[reportArgumentType]
         )
         raw = RawReactionActionEvent(data, emoji, "REACTION_REMOVE")
@@ -957,7 +957,7 @@ def parse_message_reaction_remove_emoji(
             id=emoji_id,
             animated=emoji.get("animated", False),
             # may be `None` in gateway events if custom emoji data isn't available anymore
-            # https://discord.com/developers/docs/resources/emoji#emoji-object-custom-emoji-examples
+            # https://docs.discord.com/developers/resources/emoji#emoji-object-custom-emoji-examples
             name=emoji["name"],  # pyright: ignore[reportArgumentType]
         )
         raw = RawReactionClearEmojiEvent(data, emoji)
diff --git a/disnake/types/activity.py b/disnake/types/activity.py
@@ -43,7 +43,7 @@ class ActivityParty(TypedDict, total=False):
 
 class ActivityAssets(TypedDict, total=False):
     # large_image/small_image may be a snowflake or prefixed media proxy ID, see:
-    # https://discord.com/developers/docs/topics/gateway-events#activity-object-activity-asset-image
+    # https://docs.discord.com/developers/events/gateway-events#activity-object-activity-asset-image
     large_image: str
     large_text: str
     large_url: str
diff --git a/disnake/types/appinfo.py b/disnake/types/appinfo.py
@@ -71,7 +71,7 @@ class PartialAppInfo(BaseAppInfo, total=False):
     flags: int
 
 
-# see https://discord.com/developers/docs/topics/gateway-events#ready-ready-event-fields
+# see https://docs.discord.com/developers/events/gateway-events#ready-ready-event-fields
 class PartialGatewayAppInfo(TypedDict):
     id: Snowflake
     flags: int
diff --git a/disnake/types/components.py b/disnake/types/components.py
@@ -76,7 +76,7 @@
 
 class _BaseComponent(TypedDict):
     type: ReadOnly[ComponentType]
-    id: int  # note: technically optional when sending, we just default to 0 for simplicity, which is equivalent (https://discord.com/developers/docs/components/reference#anatomy-of-a-component)
+    id: int  # note: technically optional when sending, we just default to 0 for simplicity, which is equivalent (https://docs.discord.com/developers/components/reference#anatomy-of-a-component)
 
 
 class ActionRow(_BaseComponent):
diff --git a/disnake/types/gateway.py b/disnake/types/gateway.py
diff --git a/disnake/voice_client.py b/disnake/voice_client.py
diff --git a/docs/api/events.rst b/docs/api/events.rst
diff --git a/docs/conf.py b/docs/conf.py
diff --git a/docs/whats_new.rst b/docs/whats_new.rst
diff --git a/examples/interactions/subcmd.py b/examples/interactions/subcmd.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Update links/references to Discord API docs.`