Skip to content

Commit fc6b720

Browse files
committed
Added Next Gen Docs
1 parent f30867b commit fc6b720

File tree

8 files changed

+212
-111
lines changed

8 files changed

+212
-111
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -22,82 +22,13 @@ See the [README](https://github.com/discord/discord-api-docs/blob/main/README.md
2222

2323
## Markdown Syntax
2424

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.
2626

27-
### H6 Headings
27+
We also support the following formatting from Mintlify:
2828

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-
![Available alert types](images/alerts.webp)
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-
![Collapsible MDX Component with the list icon](images/mdx-collapsible.webp)
72-
73-
```markdown
74-
<Collapsible title="Title" description="Description text" icon="list">
75-
Collapsed content
76-
</Collapsible>
77-
```
78-
79-
#### Buttons
80-
81-
Buttons are simply... clickable buttons. They take `href` and `color` as arguments, but currently we only use `"brand"` as a value for `color`.
82-
83-
###### Example
84-
85-
![Button MDX Component](images/mdx-button.webp)
86-
87-
```markdown
88-
<LinkButton to="https://discord.com/developers/docs/getting-started" color="brand" text="click the button!" />
89-
```
90-
91-
#### Cards
92-
93-
Cards let you display links in a card format. They accept two arguments, `title` and `link`.
94-
95-
###### Example
96-
97-
![Card MDX Component](images/mdx-card.webp)
98-
99-
```markdown
100-
<Card title="Card Title" href="https://discord.com/developers/docs/getting-started">
101-
This is the content inside of the card~
102-
</Card>
103-
```
29+
- [Format Text](https://www.mintlify.com/docs/create/text)
30+
- [Format Code](https://www.mintlify.com/docs/create/code)
31+
- [Images & Embeds](https://www.mintlify.com/docs/create/image-embeds)
32+
- [Files](https://www.mintlify.com/docs/create/files)
33+
- [Lists & Tables](https://www.mintlify.com/docs/create/list-table)
34+
- [Available Components](https://www.mintlify.com/docs/components/accordions)

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Discord API Documentation
1+
# Discord for Developers Documentation
22

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.
44

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.
66

77
We welcome your contributions!
88

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)
1111
- 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.
1212

1313
### Local Preview
@@ -18,16 +18,17 @@ Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview th
1818
npm i -g mintlify
1919
```
2020

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.
2222

2323
```
24+
cd discord
2425
mintlify dev
2526
```
2627

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:
2829

2930
```
30-
http://localhost:3000/developers/docs/
31+
http://localhost:3000/developers/docs/intro
3132
```
3233

3334
## Need some help?

discord/developers/docs/change-log.mdx

Lines changed: 97 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,75 @@ title: "Change Log"
33
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)."
44
---
55

6+
import {Route} from '/snippets/route.jsx'
7+
68
---
79

8-
import {Route} from '/snippets/route.jsx'
10+
<Update label="Next Generation Docs Project" description="2025-11-06" tags={["Docs"]}>
11+
12+
## Next Generation Docs Project
13+
14+
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>
970

1071
<Update label="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+
1175
A new release of the Discord Social SDK is now available, with the following updates:
1276

1377
## New Features
@@ -41,6 +105,9 @@ import {Route} from '/snippets/route.jsx'
41105
</Update>
42106

43107
<Update label="Discord Social SDK Release 1.6" description="2025-09-26" tags={["Discord Social SDK"]}>
108+
109+
## Discord Social SDK Release 1.6
110+
44111
A new release of the Discord Social SDK is now available, with the following updates:
45112

46113
### ✨ New Features
@@ -84,6 +151,9 @@ import {Route} from '/snippets/route.jsx'
84151
</Update>
85152

86153
<Update label="Adding More Modal Components!" description="2025-09-10" tags={["Interactions", "Components"]}>
154+
155+
## Adding More Modal Components!
156+
87157
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.
88158

89159
#### Components Now Supported in Modals:
@@ -104,10 +174,16 @@ import {Route} from '/snippets/route.jsx'
104174
</Update>
105175

106176
<Update label="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+
107180
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.
108181
</Update>
109182

110183
<Update label="Deprecating Non-E2EE Voice Calls" description="2025-09-02" tags={["Voice"]}>
184+
185+
## Deprecating Non-E2EE Voice Calls
186+
111187
We started work on end-to-end encryption for Discord over two years ago to enhance our user privacy and security. With
112188
DAVE now supported across all platforms, we’re very close to making every call fully end-to-end encrypted.
113189

@@ -133,6 +209,9 @@ import {Route} from '/snippets/route.jsx'
133209
</Update>
134210

135211
<Update label="Discord Social SDK Release 1.5.11353" description="2025-08-28" tags={["Discord Social SDK"]}>
212+
213+
## Discord Social SDK Release 1.5.11353
214+
136215
A new release of the Discord Social SDK is now available, with the following updates:
137216

138217
### Unity Plugin
@@ -149,6 +228,9 @@ import {Route} from '/snippets/route.jsx'
149228
</Update>
150229

151230
<Update label="Introducing New Modal Components!" description="2025-08-25" tags={["Interactions", "Components"]}>
231+
232+
## Introducing New Modal Components!
233+
152234
You asked for them, and now they're here! Modals are getting new components!!
153235

154236
#### What's New
@@ -183,10 +265,13 @@ import {Route} from '/snippets/route.jsx'
183265
</Update>
184266

185267
<Update label="Pin Permission Split" description="2025-08-20" tags={["Breaking Changes", "HTTP API"]}>
186-
[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.
187270
</Update>
188271

189272
<Update label="Discord Social SDK Release 1.5" description="2025-08-15" tags={["Discord Social SDK"]}>
273+
## Discord Social SDK Release 1.5
274+
190275
A new release of the Discord Social SDK is now available, with the following updates:
191276

192277
### **DM History Support**
@@ -254,6 +339,8 @@ import {Route} from '/snippets/route.jsx'
254339
</Update>
255340

256341
<Update label="Introducing Rate Limit When Requesting All Guild Members" description="2025-08-14" tags={["Gateway"]}>
342+
## Introducing Rate Limit When Requesting All Guild Members
343+
257344
We're introducing a change to the [Request Guild Members](/developers/docs/events/gateway-events#request-guild-members) gateway opcode.
258345

259346
### What's changing?
@@ -292,7 +379,7 @@ import {Route} from '/snippets/route.jsx'
292379

293380
### Timeline
294381

295-
Most apps wont 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.
296383

297384
### What you need to do
298385

@@ -305,7 +392,7 @@ import {Route} from '/snippets/route.jsx'
305392
</Update>
306393

307394
<Update label="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
309396

310397
Communication features (cross-platform messaging, voice chat, lobbies, and linked channels) are now generally available for all Discord
311398
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'
330417
</Update>
331418

332419
<Update label="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+
333422
We've made a few improvements to the Embedded App SDK for version 2.2.0, here are the highlights:
334423

335424
### Changes in version 2.1
@@ -353,6 +442,8 @@ import {Route} from '/snippets/route.jsx'
353442
</Update>
354443

355444
<Update label="Remove .proxy/ from Discord Activity proxy path" description="July 30, 2025" tags={["Activities", "Embedded App SDK"]}>
445+
## Remove .proxy/ from Discord Activity proxy path
446+
356447
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.
357448

358449
#### Before
@@ -393,6 +484,8 @@ import {Route} from '/snippets/route.jsx'
393484
</Update>
394485

395486
<Update label="Guild Create Deprecation" description="July 28, 2025" tags={["HTTP API"]}>
487+
## Guild Create Deprecation
488+
396489
Apps can no longer create guilds. The documentation for these endpoints has been removed and the endpoints have been removed from the OpenAPI specification.
397490

398491
See our [earlier changelog entry](/developers/docs/change-log#deprecating-guild-creation-by-apps) for more information.

discord/developers/docs/intro.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ import {CircleQuestionIcon} from '/snippets/icons/CircleQuestionIcon.jsx'
2121
<p id="hero-tagline">Build Where the World Plays</p>
2222
<p>Create social games, experiences, and integrations for millions of users on Discord</p>
2323
</div>
24-
<div id="hero-image" />
24+
<div id="hero-image">
25+
<img src="/images/frame-wumpus.png" alt="Discord Developers" />
26+
</div>
2527
</div>
2628
</div>
2729

discord/docs.json

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,6 @@
1515
"eyebrows": "breadcrumbs"
1616
},
1717
"favicon": "/favicon.png",
18-
"fonts": {
19-
"body": {
20-
"family": "gg sans",
21-
"weight": 400,
22-
"format": "woff2"
23-
},
24-
"heading": {
25-
"family": "gg sans",
26-
"weight": 600,
27-
"format": "woff2"
28-
}
29-
},
3018
"errors": {
3119
"404": {
3220
"redirect": false
@@ -342,6 +330,10 @@
342330
"linkedin": "https://www.linkedin.com/showcase/discord-developers"
343331
}
344332
},
333+
"banner" : {
334+
"content": "New docs? Check out the [change log](/developers/docs/change-log#next-generation-docs-project) to learn more!",
335+
"dismissible": true
336+
},
345337
"integrations": {
346338
"gtm": {
347339
"tagId": "G-5CWMJQ1S0X"

discord/styles/fonts.css

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,20 @@ Imports Discord brand font
3030
src: url('https://mintlify-assets.b-cdn.net/fonts/discord/gg_800.woff2')
3131
}
3232

33+
body {
34+
font-family: "gg sans", var(--font-inter), -apple-system, BlinkMacSystemFont, "Segoe UI", system-ui, sans-serif;
35+
font-weight: 400;
36+
}
37+
38+
h1, h2, h3, h4, h5, h6 {
39+
font-family: "gg sans", var(--font-inter), -apple-system, BlinkMacSystemFont, "Segoe UI", system-ui, sans-serif;
40+
font-weight: 600;
41+
}
42+
43+
.\[\&_\*\:not\(h1\2c h2\2c h3\2c h4\2c h5\2c h6\2c h1_\*\2c h2_\*\2c h3_\*\2c h4_\*\2c h5_\*\2c h6_\*\)\]\:font-bodyWeight :not(h1,h2,h3,h4,h5,h6,h1 *,h2 *,h3 *,h4 *,h5 *,h6 *) {
44+
font-weight: 400;
45+
}
46+
3347

3448

3549

0 commit comments

Comments
 (0)