Skip to content

Commit a62c908

Browse files
Normalize links (#7475)
1 parent 7206885 commit a62c908

File tree

228 files changed

+2944
-2934
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

228 files changed

+2944
-2934
lines changed

docs/activities/building-an-activity.mdx

+25-25
Large diffs are not rendered by default.

docs/activities/design-patterns.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ Make your app fast, easy to join, and maximize fun to launch a crowd favorite.
7171

7272
### Keep load times as low as possible
7373
- This allows for easier drop-in drop-out behavior for the large portion of mobile users on Discord.
74-
- See the below [Quality & Testing Recommendations](#DOCS_ACTIVITIES_DESIGN_PATTERNS/quality-and-testing) for key areas of minimum quality support and testing recommendations.
75-
- See the below [Technical Considerations](#DOCS_ACTIVITIES_DESIGN_PATTERNS/technical-considerations) for recommendations on how to partition loading and work with various development tools to reduce load times.
74+
- See the below [Quality & Testing Recommendations](/docs/activities/design-patterns#quality-and-testing) for key areas of minimum quality support and testing recommendations.
75+
- See the below [Technical Considerations](/docs/activities/design-patterns#technical-considerations) for recommendations on how to partition loading and work with various development tools to reduce load times.
7676
- Consider different screen sizes and orientations across desktop and mobile devices and make sure UI elements scale appropriately.
7777

7878
### Support drop-in, drop-out behavior

docs/activities/development-guides.mdx

+52-52
Large diffs are not rendered by default.

docs/activities/how-activities-work.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
Activities are web applications that run in an iframe within Discord on desktop, mobile and web. In order to achieve this, we use the [`postMessage`](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) protocol to enable secure communication between your application and Discord.
44

5-
The [Embedded App SDK](https://github.com/discord/embedded-app-sdk) simplifies this process by managing the `postMessage` protocol on your behalf. For details on available commands and their usage, consult the [SDK Reference](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK). Our [Sample Projects](#DOCS_ACTIVITIES_OVERVIEW/sample-projects) provide practical examples of how to implement these features.
5+
The [Embedded App SDK](https://github.com/discord/embedded-app-sdk) simplifies this process by managing the `postMessage` protocol on your behalf. For details on available commands and their usage, consult the [SDK Reference](/docs/developer-tools/embedded-app-sdk). Our [Sample Projects](/docs/activities/overview#sample-projects) provide practical examples of how to implement these features.
66

77
## Designed for Single-Page Apps (SPAs)
88

9-
This SDK is intended for use by a single-page application. We recognize developers may be using frameworks or approaches that are not an exact fit for single-page applications. We recommend nesting those frameworks inside your Activity's top-level single-page application and passing messages as you see fit. Please refer to the [Nested Messages App](#DOCS_ACTIVITIES_OVERVIEW/sample-projects) sample project for guidance on this approach.
9+
This SDK is intended for use by a single-page application. We recognize developers may be using frameworks or approaches that are not an exact fit for single-page applications. We recommend nesting those frameworks inside your Activity's top-level single-page application and passing messages as you see fit. Please refer to the [Nested Messages App](/docs/activities/overview#sample-projects) sample project for guidance on this approach.
1010

1111
## Activity Lifecycle
1212

@@ -20,7 +20,7 @@ This SDK is intended for use by a single-page application. We recognize develope
2020
## Sample Code and Activity Lifecycle Diagram
2121

2222
> info
23-
> Below is a minimal example of setting up the SDK. Please see our [Sample Projects](#DOCS_ACTIVITIES_OVERVIEW/sample-projects) for more complete sample applications.
23+
> Below is a minimal example of setting up the SDK. Please see our [Sample Projects](/docs/activities/overview#sample-projects) for more complete sample applications.
2424
2525
```javascript
2626
import {DiscordSDK} from '@discord/embedded-app-sdk';

docs/activities/overview.mdx

+13-13
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ sidebar_label: Overview
88

99
**Activities** are multiplayer games and social experiences that can be launched in Discord. Activities can integrate with Discord features like user identity, voice and chat, profile data like Rich Presence, and native monetization.
1010

11-
Under the hood, Activities are single page web apps hosted in an iframe and use the [Embedded App SDK](#DOCS_ACTIVITIES_OVERVIEW/embedded-app-sdk) to communicate with Discord clients. This page focuses on how Activities are launched and built, but you can explore real-world Activities by reading some of our [developer case studies](https://discord.com/build#case-studies), or by trying a few out in Discord. You can also jump right into building using some of the resources below.
11+
Under the hood, Activities are single page web apps hosted in an iframe and use the [Embedded App SDK](/docs/activities/overview#embedded-app-sdk) to communicate with Discord clients. This page focuses on how Activities are launched and built, but you can explore real-world Activities by reading some of our [developer case studies](https://discord.com/build#case-studies), or by trying a few out in Discord. You can also jump right into building using some of the resources below.
1212

1313
<Container>
14-
<Card title="Build Your First Discord Activity" link="#DOCS_ACTIVITIES_BUILDING_AN_ACTIVITY">
14+
<Card title="Build Your First Discord Activity" link="/docs/activities/building-an-activity">
1515
Follow the guide to build your first Activity using the Embedded App SDK.
1616
</Card>
17-
<Card title="Development Patterns" link="#DOCS_ACTIVITIES_DEVELOPMENT_GUIDES">
17+
<Card title="Development Patterns" link="/docs/activities/development-guides">
1818
Explore common development patterns and practices to make building Activities simpler.
1919
</Card>
20-
<Card title="How Activities Work" link="#DOCS_ACTIVITIES_HOW_ACTIVITIES_WORK">
20+
<Card title="How Activities Work" link="/docs/activities/how-activities-work">
2121
Learn more about the lifecycle of Activities and how they run in Discord clients.
2222
</Card>
2323
</Container>
@@ -34,41 +34,41 @@ Each of these are covered in more detail in the below sections.
3434

3535
### Entry Point Command
3636

37-
Activities are primarily opened when users invoke your app's [Entry Point command](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/entry-point-commands) in the App Launcher.
37+
Activities are primarily opened when users invoke your app's [Entry Point command](/docs/interactions/application-commands#entry-point-commands) in the App Launcher.
3838

39-
When you enable Activities for your app, a [default Entry Point command](#DOCS_INTERACTIONS_APPLICATION_COMMANDS/default-entry-point-command) called "Launch" is created for you. By default, Discord automatically handles opening your Activity when your Entry Point command is run by a user.
39+
When you enable Activities for your app, a [default Entry Point command](/docs/interactions/application-commands#default-entry-point-command) called "Launch" is created for you. By default, Discord automatically handles opening your Activity when your Entry Point command is run by a user.
4040

41-
Read more about setting up Entry Point commands in the [development guide](#DOCS_ACTIVITIES_DEVELOPMENT_GUIDES/setting-up-an-entry-point-command).
41+
Read more about setting up Entry Point commands in the [development guide](/docs/activities/development-guides#setting-up-an-entry-point-command).
4242

4343
### Interaction Response
4444

45-
Activities can be launched in response to [command](#DOCS_INTERACTIONS_OVERVIEW/commands), [message component](#DOCS_INTERACTIONS_OVERVIEW/message-components), and [modal submission](#DOCS_INTERACTIONS_OVERVIEW/modals) interactions. To open an Activity, set the callback type to `LAUNCH_ACTIVITY` (type `12`) when [responding to the interaction](#DOCS_INTERACTIONS_RECEIVING_AND_RESPONDING/responding-to-an-interaction).
45+
Activities can be launched in response to [command](/docs/interactions/overview#commands), [message component](/docs/interactions/overview#message-components), and [modal submission](/docs/interactions/overview#modals) interactions. To open an Activity, set the callback type to `LAUNCH_ACTIVITY` (type `12`) when [responding to the interaction](/docs/interactions/receiving-and-responding#responding-to-an-interaction).
4646

4747
---
4848

4949
## Developing Activities
5050

51-
Whether you're developing a multiplayer game, a new social experience, or another creative idea, your Activity will be built as a web app that is run in an iframe in Discord on desktop, mobile, and web. You can get started by following the guide on [Building an Activity using the Embedded App SDK](#DOCS_ACTIVITIES_BUILDING_AN_ACTIVITY) or exploring the [sample projects](#DOCS_ACTIVITIES_OVERVIEW/sample-projects)
51+
Whether you're developing a multiplayer game, a new social experience, or another creative idea, your Activity will be built as a web app that is run in an iframe in Discord on desktop, mobile, and web. You can get started by following the guide on [Building an Activity using the Embedded App SDK](/docs/activities/building-an-activity) or exploring the [sample projects](/docs/activities/overview#sample-projects)
5252

53-
The sections below provide an overview of the Embedded App SDK, but technical details about how Activities are run in Discord is covered in [How Activities Work](#DOCS_ACTIVITIES_HOW_ACTIVITIES_WORK).
53+
The sections below provide an overview of the Embedded App SDK, but technical details about how Activities are run in Discord is covered in [How Activities Work](/docs/activities/how-activities-work).
5454

5555
### Embedded App SDK
5656

57-
The [Embedded App SDK](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK) handles all of the communication between Discord and your app, making it easier to do common tasks like managing connected users, supporting mobile clients, and debugging your Activity.
57+
The [Embedded App SDK](/docs/developer-tools/embedded-app-sdk) handles all of the communication between Discord and your app, making it easier to do common tasks like managing connected users, supporting mobile clients, and debugging your Activity.
5858

5959
The Embedded App SDK offers different events and commands to handle the communication between Discord and your Activity, which are covered more below.
6060

6161
#### Commands
6262

6363
The SDK has a set of commands you can call to interact with a Discord client, given you have the appropriate scopes. This is helpful when you want to do authorize and authenticate users, fetch information about your Activity, or update information for your Activity or an authenticated user.
6464

65-
Read the [Embedded App SDK documentation](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/sdk-commands) for a full list of commands, and details about each command.
65+
Read the [Embedded App SDK documentation](/docs/developer-tools/embedded-app-sdk#sdk-commands) for a full list of commands, and details about each command.
6666

6767
#### Events
6868

6969
The SDK also has events you can subscribe (or unsubscribe) to for things happening in a connected client that are relevant to your Activity, given you have the appropriate scopes. This is helpful when you want to do things like handle initial connection and thrown errors, listen to updates about a connected user, and listen to events related to your Activity instance.
7070

71-
Read the [Embedded App SDK documentation](#DOCS_DEVELOPER_TOOLS_EMBEDDED_APP_SDK/sdk-events) for a full list of events, and details for each event.
71+
Read the [Embedded App SDK documentation](/docs/developer-tools/embedded-app-sdk#sdk-events) for a full list of events, and details for each event.
7272

7373

7474
---

docs/change-log/2017-07-19-breaking-change-version-6.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ date: "2017-07-19"
44
breaking: true
55
---
66

7-
* [Channel](#DOCS_RESOURCES_CHANNEL/channel-object) Object
7+
* [Channel](/docs/resources/channel#channel-object) Object
88
* `is_private` removed
9-
* [`type`](#DOCS_RESOURCES_CHANNEL/channel-object-channel-types) is now an integer
10-
* `recipient` is now `recipients`, an array of [user](#DOCS_RESOURCES_USER/user-object) objects
11-
* [Message](#DOCS_RESOURCES_MESSAGE/message-object) Object
12-
* [`type`](#DOCS_RESOURCES_MESSAGE/message-object-message-types) added to support system messages
13-
* [Status Update](#DOCS_EVENTS_GATEWAY_EVENTS/update-presence-gateway-presence-update-structure) Object
9+
* [`type`](/docs/resources/channel#channel-object-channel-types) is now an integer
10+
* `recipient` is now `recipients`, an array of [user](/docs/resources/user#user-object) objects
11+
* [Message](/docs/resources/message#message-object) Object
12+
* [`type`](/docs/resources/message#message-object-message-types) added to support system messages
13+
* [Status Update](/docs/events/gateway-events#update-presence-gateway-presence-update-structure) Object
1414
* `idle_since` renamed to `since`

docs/change-log/2017-07-24-new-feature-audit-logs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "New Feature: Audit Logs"
33
date: "2017-07-24"
44
---
55

6-
Audit logs are here! Well, they've been here all along, but now we've got [documentation](#DOCS_RESOURCES_AUDIT_LOG/) about them. Check it out, but remember: with great power comes great responsibility.
6+
Audit logs are here! Well, they've been here all along, but now we've got [documentation](/docs/resources/audit-log#) about them. Check it out, but remember: with great power comes great responsibility.

docs/change-log/2017-08-16-breaking-change-presence-activity-objects.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ date: "2017-08-16"
44
breaking: true
55
---
66

7-
The `type` field in the [activity object](#DOCS_EVENTS_GATEWAY_EVENTS/activity-object) for [Gateway Status Update](#DOCS_EVENTS_GATEWAY_EVENTS/update-presence) and [Presence Update](#DOCS_EVENTS_GATEWAY_EVENTS/presence-update) payloads is no longer optional when the activity object is not null.
7+
The `type` field in the [activity object](/docs/events/gateway-events#activity-object) for [Gateway Status Update](/docs/events/gateway-events#update-presence) and [Presence Update](/docs/events/gateway-events#presence-update) payloads is no longer optional when the activity object is not null.

docs/change-log/2017-09-10-new-feature-emoji-endpoints.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "New Feature: Emoji Endpoints"
33
date: "2017-09-10"
44
---
55

6-
[Emoji endpoints](#DOCS_RESOURCES_EMOJI/emoji-resource) have been added to the API. Bots can now manage guild emojis to their robo-hearts' content!
6+
[Emoji endpoints](/docs/resources/emoji#emoji-resource) have been added to the API. Bots can now manage guild emojis to their robo-hearts' content!

docs/change-log/2017-09-20-new-feature-channel-categories.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "New Feature: Channel Categories"
33
date: "2017-09-20"
44
---
55

6-
Changes have been made throughout the documentation to reflect the addition of channel categories to Discord. These includes an additional field—`parent_id`—to the base [channel](#DOCS_RESOURCES_CHANNEL/channel-object) object and a new [channel category example](#DOCS_RESOURCES_CHANNEL/channel-object-example-channel-category).
6+
Changes have been made throughout the documentation to reflect the addition of channel categories to Discord. These includes an additional field—`parent_id`—to the base [channel](/docs/resources/channel#channel-object) object and a new [channel category example](/docs/resources/channel#channel-object-example-channel-category).

docs/change-log/2017-10-16-breaking-change-api-gateway-below-v6-discontinued.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ date: "2017-10-16"
44
breaking: true
55
---
66

7-
[API](#DOCS_REFERENCE/api-versioning) and Gateway versions below v6 are now discontinued after being previously deprecated. Version 6 is now the default API and Gateway version. Attempting to use a version below 6 will result in an error.
7+
[API](/docs/reference#api-versioning) and Gateway versions below v6 are now discontinued after being previously deprecated. Version 6 is now the default API and Gateway version. Attempting to use a version below 6 will result in an error.

docs/change-log/2017-11-09-new-feature-rich-presence.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ Rich Presence is now live and available for all developers! Rich Presence allows
99
* Allowing users to post invitations to join their party or spectate their game in chat
1010
* Displaying "Spectate" and "Ask to Join" buttons on users' profiles
1111

12-
For more information, check out our [Rich Presence site](https://discord.com/rich-presence). To get started on development, [read the docs](#DOCS_RICH_PRESENCE_OVERVIEW)!
12+
For more information, check out our [Rich Presence site](https://discord.com/rich-presence). To get started on development, [read the docs](/docs/rich-presence/overview)!

docs/change-log/2018-01-03-semi-breaking-change-very-large-bot-sharding.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ date: "2018-01-03"
44
breaking: true
55
---
66

7-
Additional sharding requirements and information for bots in over 100,000 guilds has been added. This requires a small change in numbers of shards for affected bots. See the [documentation](#DOCS_EVENTS_GATEWAY/sharding-for-large-bots) for more information.
7+
Additional sharding requirements and information for bots in over 100,000 guilds has been added. This requires a small change in numbers of shards for affected bots. See the [documentation](/docs/events/gateway#sharding-for-large-bots) for more information.

docs/change-log/2018-01-23-deprecation-accept-invite-endpoint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "Deprecation: Accept Invite Endpoint"
33
date: "2018-01-23"
44
---
55

6-
The [Accept Invite](#DOCS_RESOURCES_INVITE/) endpoint is deprecated starting today, and will be discontinued on March 23, 2018. The [Add Guild Member](#DOCS_RESOURCES_GUILD/add-guild-member) endpoint should be used in its place.
6+
The [Accept Invite](/docs/resources/invite#) endpoint is deprecated starting today, and will be discontinued on March 23, 2018. The [Add Guild Member](/docs/resources/guild#add-guild-member) endpoint should be used in its place.

docs/change-log/2018-01-30-enhancement-get-guild-emoji-endpoint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "Enhancement: Get Guild Emoji Endpoint"
33
date: "2018-01-30"
44
---
55

6-
The [Get Guild Emoji](#DOCS_RESOURCES_EMOJI/get-guild-emoji) response now also includes a user object if the emoji was added by a user.
6+
The [Get Guild Emoji](/docs/resources/emoji#get-guild-emoji) response now also includes a user object if the emoji was added by a user.

docs/change-log/2018-02-05-enhancement-new-message-properties.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "Enhancement: New Message Properties"
33
date: "2018-02-05"
44
---
55

6-
Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](#DOCS_RESOURCES_MESSAGE/message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212-Discord-Spotify-Connection) and previous Rich Presence enhancements.
6+
Additional `activity` and `application` fields—as well as corresponding object documentation—have been added to the [Message](/docs/resources/message#message-object) object in support of our newly-released [Spotify integration](https://support.discord.com/hc/en-us/articles/360000167212-Discord-Spotify-Connection) and previous Rich Presence enhancements.

docs/change-log/2018-06-19-documentation-fix-list-of-open-dms-in-certain-payloads.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "Documentation Fix: List of Open DMS in Certain Payloads"
33
date: "2018-06-19"
44
---
55

6-
The documentation has been updated to correctly note that the `private_channels` field in the [Ready](#DOCS_EVENTS_GATEWAY_EVENTS/ready) should be an empty array, as well as the response from `/users/@me/channels` for a bot user. This change has been in effect for a long time, but the documentation was not updated.
6+
The documentation has been updated to correctly note that the `private_channels` field in the [Ready](/docs/events/gateway-events#ready) should be an empty array, as well as the response from `/users/@me/channels` for a bot user. This change has been in effect for a long time, but the documentation was not updated.

docs/change-log/2018-11-30-enhancement-user-object.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "Enhancement: User Object"
33
date: "2018-11-30"
44
---
55

6-
The [User object](#DOCS_RESOURCES_USER/user-object) now includes two new additional fields, `premium_type` and `flags`. These can be used to know the Nitro status of a user, or determine which HypeSquad house a user is in.
6+
The [User object](/docs/resources/user#user-object) now includes two new additional fields, `premium_type` and `flags`. These can be used to know the Nitro status of a user, or determine which HypeSquad house a user is in.

docs/change-log/2019-04-18-new-invite-object-fields.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ title: "New Invite Object Fields"
33
date: "2019-04-18"
44
---
55

6-
The [Invite Object](#DOCS_RESOURCES_INVITE/invite-object) now includes two additional fields, `target_user` and `target_user_type`.
6+
The [Invite Object](/docs/resources/invite#invite-object) now includes two additional fields, `target_user` and `target_user_type`.

0 commit comments

Comments
 (0)