You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+8-77Lines changed: 8 additions & 77 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,82 +22,13 @@ See the [README](https://github.com/discord/discord-api-docs/blob/main/README.md
22
22
23
23
## Markdown Syntax
24
24
25
-
This repository uses special markdown syntax that helps style the resulting web version of the documentation.
25
+
Our documentation uses standard [Markdown](https://www.markdownguide.org/basic-syntax/) syntax with some additional [MDX](https://mdxjs.com/) features.
26
26
27
-
### H6 Headings
27
+
We also support the following formatting from Mintlify:
28
28
29
-
H6 headings should be used above tables and code blocks to properly label them.
30
-
31
-
### Linking
32
-
33
-
Links between docs can be achieved by using a hash symbol (#), plus the markdown file name, plus a slash, and finally the dash-separated anchor. For instance, to link to the above H6 heading section:
34
-
35
-
```md
36
-
[Links to README.md H6](#README/h6-headings)
37
-
```
38
-
39
-
### Alert Boxes
40
-
41
-
Alert boxes are created by placing a line with 3 colons (`:::`) before and after the text. The first 3 colons must be followed by a label specifying the alert box type. For example, to create a warning alert:
42
-
43
-
```
44
-
:::warn
45
-
Something that requires warning here
46
-
:::
47
-
```
48
-
49
-
Currently the following types are available: `info`, `warn`, `danger` and `preview`
50
-
51
-

52
-
53
-
### MDX Components
54
-
55
-
There are a few reusable MDX components that can be used on pages with the `mdx` extension.
56
-
57
-
#### Collapsibles
58
-
59
-
Collapsibles allow you to show/hide content on a page that may be secondary to the page's primary content. They have four fields that can be set: `title`, `description`, `icon`, and an `open` flag (which makes the collapsible element open by default).
60
-
61
-
Available options for `icon`:
62
-
63
-
-`"list"`
64
-
-`"view"`
65
-
-`"question"`
66
-
-`"code"`
67
-
-`"warning"`
68
-
69
-
###### Example
70
-
71
-

Copy file name to clipboardExpand all lines: README.md
+9-8Lines changed: 9 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,13 @@
1
-
# Discord API Documentation
1
+
# Discord for Developers Documentation
2
2
3
-
This repo contains the official Discord API documentation, which can be viewed online [HERE](https://discord.com/developers/docs/intro). Before submitting pull-requests, please remember to _fully_ read the [Contributing](CONTRIBUTING.md) guidelines.
3
+
This repo contains the official Discord for Developers documentation, which can be viewed online [HERE](https://discord.com/developers/docs/intro). Before submitting pull-requests, please remember to _fully_ read the [Contributing](CONTRIBUTING.md) guidelines.
4
4
5
-
This repository reflects the Discord API as it is meant to be accessed by third-party applications. It omits features and capabilities that are not generally available, or are not fully supported for third-party usage.
5
+
This repository reflects the Discord Developer Platform as it is meant to be accessed by third-party applications. It omits features and capabilities that are not generally available, or are not fully supported for third-party usage.
6
6
7
7
We welcome your contributions!
8
8
9
-
- Issue tracker: Discord API bugs
10
-
- Discussions: Discord API feature and improvement requests
9
+
- Issue tracker: [Discord API bugs](https://github.com/discord/discord-api-docs/issues)
10
+
- Discussions: [Discord API feature and improvement requests](https://github.com/discord/discord-api-docs/discussions/categories/api-feature-requests-ideas)
11
11
- Pull Requests: See [Contributing.md](https://github.com/discord/discord-api-docs/blob/main/CONTRIBUTING.md) for types of changes accepted and specific markdown syntax used in the documentation.
12
12
13
13
### Local Preview
@@ -18,16 +18,17 @@ Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview th
18
18
npm i -g mintlify
19
19
```
20
20
21
-
Run the following command at the root of the docs to see your changes locally.
21
+
Run the `mintlify dev` in the `discord` directory to see your changes locally.
22
22
23
23
```
24
+
cd discord
24
25
mintlify dev
25
26
```
26
27
27
-
You will need to add `/developers/docs/` to the preview URL to see the docs and your changes.
28
+
Your local browser should open automatically to the correct page, but if not, navigate to:
Copy file name to clipboardExpand all lines: discord/developers/docs/change-log.mdx
+97-4Lines changed: 97 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,75 @@ title: "Change Log"
3
3
description: "Discover the latest updates, new features, and bug fixes on the Discord Developer Platform. To join in on the conversation, join the [Discord Developers Server](https://discord.com/invite/discord-developers)."
We're excited to announce the launch of our Next Gen Docs project! This initiative aims to improve the way developers interact with Discord's developer documentation, making it more accessible, comprehensive, and user-friendly.
15
+
16
+
## Our Goal
17
+
18
+
The Discord API has evolved far beyond its origins as a platform for bots. Today, we're a comprehensive developer platform supporting:
19
+
20
+
-**Discord Apps and Bots** - The foundation of our ecosystem, extending Discord's functionality with custom apps, commands, and integrations
21
+
-**Discord Activities** - Real-time games and social experiences that users can launch directly inside Discord
22
+
-**Social SDK for Games** - Bringing Discord-powered features like voice, chat, rich presence, and social graph to games
23
+
24
+
Our documentation needs to evolve with us. With this project, we're not just updating our docs. We're aiming to improve the entire developer experience for learning and building on Discord as it exists in 2025 and beyond.
25
+
26
+
## Our Next Gen Docs Journey
27
+
28
+
**What we've done so far:**
29
+
- Migrated to [Mintlify](https://mintlify.com) for a modern documentation experience
30
+
- For this migration, we preserved our existing content and familiar design but plan to evolve this over time
31
+
- We no longer have to maintain and build our own documentation platform and can instead focus on making content and improving our developer experience
32
+
- Gained new capabilities:
33
+
-**PR Previews** - See documentation changes before they go live! This works locally as well as in your pull requests
34
+
-**More Components and Docs Features** - We now have access to all of Mintlify's documentation components that will continue to grow over time
35
+
-**AI features & improved search** - You can now send our docs to your LLM of choice or access them via MCP (more on this soon!)
36
+
37
+
If you're reading this, the migration is complete! 🎉
38
+
39
+
<Warning>
40
+
This migration did require us to reorganize the entire repository and make a lot of formatting changes. If you have an open PR, it will be a pretty gnarly merge conflict to resolve. We will be focusing on getting our PR backlog down over the next few weeks.
41
+
</Warning>
42
+
43
+
<Info>
44
+
We combed through the existing documentation to ensure everything was migrated correctly, but if you spot anything that looks off, please let us know by opening an issue or submitting feedback [here](https://github.com/discord/discord-api-docs/discussions/categories/next-gen-docs-feedback). We will be actively monitoring feedback to quickly address any issues.
45
+
</Info>
46
+
47
+
## Why This Matters
48
+
49
+
Great documentation isn't just about having the right information, it's about presenting it in a way that helps developers succeed.
50
+
51
+
In the coming months, we'll be shipping changes to our documentation to ensure that it:
52
+
53
+
-**Reduces time-to-first-success** for new developers
54
+
-**Scales with complexity** as your projects grow
55
+
-**Stays current** with our rapidly evolving platform
56
+
-**Serves all skill levels** from beginners to experts
57
+
58
+
## Contributing to Our Vision
59
+
60
+
This transformation is happening with the developer community at its heart. We welcome:
61
+
62
+
-**Feedback** on what's working and what isn't
63
+
-**Content contributions** through our existing PR process
64
+
-**Bug reports** when documentation doesn't match reality
65
+
66
+
We have created a Github Discussion topic for [Next Gen Docs Feedback](https://github.com/discord/discord-api-docs/discussions/categories/next-gen-docs-feedback) to collect feedback.
67
+
68
+
See our [Contributing Guidelines](https://github.com/discord/discord-api-docs/blob/main/CONTRIBUTING.md) for how to get involved.
69
+
</Update>
9
70
10
71
<Updatelabel="Discord Social SDK Release 1.6.12170"description="2025-10-15"tags={["Discord Social SDK"]}>
72
+
73
+
## Discord Social SDK Release 1.6.12170
74
+
11
75
A new release of the Discord Social SDK is now available, with the following updates:
12
76
13
77
## New Features
@@ -41,6 +105,9 @@ import {Route} from '/snippets/route.jsx'
41
105
</Update>
42
106
43
107
<Updatelabel="Discord Social SDK Release 1.6"description="2025-09-26"tags={["Discord Social SDK"]}>
108
+
109
+
## Discord Social SDK Release 1.6
110
+
44
111
A new release of the Discord Social SDK is now available, with the following updates:
45
112
46
113
### ✨ New Features
@@ -84,6 +151,9 @@ import {Route} from '/snippets/route.jsx'
84
151
</Update>
85
152
86
153
<Updatelabel="Adding More Modal Components!"description="2025-09-10"tags={["Interactions", "Components"]}>
154
+
155
+
## Adding More Modal Components!
156
+
87
157
We've added more components to modals! All select menus (User, Role, Mentionable, Channel) are now fully supported in modals. In order to use a select menu in a modal, it must be placed inside a [Label](/developers/docs/components/reference#label) component. We've also added the [Text Display](/developers/docs/components/reference#text-display) component with markdown support as a top-level component in modals.
88
158
89
159
#### Components Now Supported in Modals:
@@ -104,10 +174,16 @@ import {Route} from '/snippets/route.jsx'
104
174
</Update>
105
175
106
176
<Updatelabel="Banner, avatar, and bio can be set on modify current member"description="2025-09-10"tags={["HTTP API"]}>
177
+
178
+
## Banner, avatar, and bio can be set on modify current member
179
+
107
180
As of September 10, 2025, bots can set `banner`, `avatar`, and `bio` fields using the [modify current member](/developers/docs/resources/guild#modify-current-member) route.
[Pinning](/developers/docs/resources/message#pin-message) and [unpinning](/developers/docs/resources/message#unpin-message) messages now has its own [permission](/developers/docs/topics/permissions#permissions-bitwise-permission-flags). We split `PIN_MESSAGES` out of `MANAGE_MESSAGES` to give more granular control over who can pin messages in a channel. This is effective immediately for both users and apps. This change will be backwards compatible until January 12th 2026 when `MANAGE_MESSAGES` will no longer grant the ability to pin or unpin messages.
268
+
## Pin Permission Split
269
+
[Pinning](/developers/docs/resources/message#pin-message) and [unpinning](/developers/docs/resources/message#unpin-message) messages now has its own [permission](/developers/docs/topics/permissions#permissions-bitwise-permission-flags). We split `PIN_MESSAGES` out of `MANAGE_MESSAGES` to give more granular control over who can pin messages in a channel. This is effective immediately for both users and apps. This change will be backwards compatible until January 12th 2026 when `MANAGE_MESSAGES` will no longer grant the ability to pin or unpin messages.
187
270
</Update>
188
271
189
272
<Updatelabel="Discord Social SDK Release 1.5"description="2025-08-15"tags={["Discord Social SDK"]}>
273
+
## Discord Social SDK Release 1.5
274
+
190
275
A new release of the Discord Social SDK is now available, with the following updates:
191
276
192
277
### **DM History Support**
@@ -254,6 +339,8 @@ import {Route} from '/snippets/route.jsx'
254
339
</Update>
255
340
256
341
<Updatelabel="Introducing Rate Limit When Requesting All Guild Members"description="2025-08-14"tags={["Gateway"]}>
342
+
## Introducing Rate Limit When Requesting All Guild Members
343
+
257
344
We're introducing a change to the [Request Guild Members](/developers/docs/events/gateway-events#request-guild-members) gateway opcode.
258
345
259
346
### What's changing?
@@ -292,7 +379,7 @@ import {Route} from '/snippets/route.jsx'
292
379
293
380
### Timeline
294
381
295
-
Most apps won’t encounter this rate limit until it is rolled out to all servers on **October 1, 2025**. However, if you are the developer of an app that is requesting all guild members in very large guilds then you may start seeing this **as soon as today**, so we can ensure platform stability.
382
+
Most apps won't encounter this rate limit until it is rolled out to all servers on **October 1, 2025**. However, if you are the developer of an app that is requesting all guild members in very large guilds then you may start seeing this **as soon as today**, so we can ensure platform stability.
296
383
297
384
### What you need to do
298
385
@@ -305,7 +392,7 @@ import {Route} from '/snippets/route.jsx'
305
392
</Update>
306
393
307
394
<Updatelabel="Discord Social SDK Communication Features - General Availability"description="2025-08-13"tags={["Discord Social SDK"]}>
308
-
###Discord Social SDK Communication Features - General Availability
395
+
## Discord Social SDK Communication Features - General Availability
309
396
310
397
Communication features (cross-platform messaging, voice chat, lobbies, and linked channels) are now generally available for all Discord
311
398
Social SDK users that meet our application process criteria. Previously available only in closed beta, these features
@@ -330,6 +417,8 @@ import {Route} from '/snippets/route.jsx'
330
417
</Update>
331
418
332
419
<Updatelabel="Embedded App SDK Version 2.1 & 2.2"description="2025-08-11"tags={["Activities", "Embedded App SDK"]}>
420
+
## Embedded App SDK Version 2.1 & 2.2
421
+
333
422
We've made a few improvements to the Embedded App SDK for version 2.2.0, here are the highlights:
334
423
335
424
### Changes in version 2.1
@@ -353,6 +442,8 @@ import {Route} from '/snippets/route.jsx'
## Remove .proxy/ from Discord Activity proxy path
446
+
356
447
We've updated the Content Security Policy (CSP) for Discord Activities to remove the `.proxy/` path requirement when making requests through the discordsays.com proxy. This change simplifies the developer experience while maintaining full backwards compatibility. This was made possible by resolving the underlying privacy considerations that originally required the `.proxy/` path restriction.
357
448
358
449
#### Before
@@ -393,6 +484,8 @@ import {Route} from '/snippets/route.jsx'
Apps can no longer create guilds. The documentation for these endpoints has been removed and the endpoints have been removed from the OpenAPI specification.
397
490
398
491
See our [earlier changelog entry](/developers/docs/change-log#deprecating-guild-creation-by-apps) for more information.
0 commit comments