Skip to content

Commit dd64acc

Browse files
committed
Format files and fix hyperlinks
1 parent 502f5d2 commit dd64acc

File tree

17 files changed

+66
-56
lines changed

17 files changed

+66
-56
lines changed

docs/Extensions/Commands/cogs.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,12 @@ access the `bot` variable outside of a function. To make an event, you have to u
106106
method, `@commands.Cog.listener()`. Events also need `self` as its first parameter.
107107

108108
And that's it! Cogs are a simple and easy way of organizing your code. Now you can check out how to
109-
create a help command [here](help-command.mdx)
109+
create a help command [here](help-command)
110110

111111
:::info Related Topics
112112

113-
- [Creating a Help Command](help-command.mdx)
114-
- [Rules and Common Practices](../Getting-Started/rules-and-common-practices.mdx)
115-
- [Prefixed Commands](prefixed-commands.mdx)
113+
- [Creating a Help Command](help-command)
114+
- [Rules and Common Practices](../../Getting-Started/rules-and-common-practices)
115+
- [Prefixed Commands](prefixed-commands)
116116

117117
:::

docs/Extensions/Commands/groups.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ async def subtract(ctx, a: int, b: int):
4343

4444
:::info Related Topics
4545

46-
- [Prefixed Commands](prefixed-commands.mdx)
47-
- [Cogs](cogs.mdx)
46+
- [Prefixed Commands](prefixed-commands)
47+
- [Cogs](cogs)
4848

4949
:::

docs/Extensions/Commands/help-command.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -469,8 +469,8 @@ Thanks to InterStella0 for making this guide amazing.
469469

470470
:::info Related Topics
471471

472-
- [Subclassing Bots](../Popular-Topics/subclassing-bots.mdx)
473-
- [Prefixed Commands](prefixed-commands.mdx)
474-
- [Cogs](cogs.mdx)
472+
- [Subclassing Bots](../../Popular-Topics/subclassing-bots)
473+
- [Prefixed Commands](prefixed-commands)
474+
- [Cogs](cogs)
475475

476476
:::

docs/Extensions/Commands/prefixed-commands.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@ with `int(guess)`.
308308

309309
:::info Related Topics
310310

311-
- [Command Groups](groups.mdx)
312-
- [Rules and Common Practices](../Getting-Started/rules-and-common-practices.mdx)
311+
- [Command Groups](groups)
312+
- [Rules and Common Practices](../../Getting-Started/rules-and-common-practices)
313313

314314
:::

docs/Getting-Started/hosting-your-bot.mdx

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22
title: Hosting Your Pycord Bot
33
---
44

5+
import Tabs from "@theme/Tabs";
6+
import TabItem from "@theme/TabItem";
7+
58
# Hosting Your Pycord Bot
69

710
If you're completely new to this, you might have thought something along the lines of "Yay! I got my
8-
bot working," after following our [Creating your First Bot](creating-your-first-bot.mdx) guide, only
11+
bot working," after following our [Creating your First Bot](creating-your-first-bot) guide, only
912
to close your IDE or shut down your computer to find your bot offline.
1013

1114
The reason for this is that programs have to be hosted somewhere, meaning some machine somewhere has
@@ -39,9 +42,9 @@ There are three types of hosts.
3942
<TabItem value="hosttype-shared" label="Shared Hosting">
4043
Shared hosting is a type of hosting where multiple people share one VPS. Getting a spot on
4144
a shared host is usually cheap, sometimes even free. Shared hosts do not give you a lot of
42-
resources, from less than 4 gigabytes of RAM and half of a CPU, with very little storage.
43-
Shared hosting is usually used for website hosting and is not recommended for hosting a Discord
44-
bot.
45+
resources, from less than a gigabyte of RAM (usually 512mb on free hosts) and half of a CPU
46+
with very little storage. Shared hosting is usually used for website hosting and is not
47+
recommended for hosting a Discord bot.
4548
</TabItem>
4649
<TabItem value="hosttype-vps" label="VPS" default>
4750
A virtual private server (VPS) is a virtual computer (virtual machine) that is rented out to
@@ -58,6 +61,7 @@ There are three types of hosts.
5861
large projects and are overkill for something like a Discord bot.
5962
</TabItem>
6063
</Tabs>
64+
<br/>
6165

6266
:::danger
6367

@@ -87,7 +91,7 @@ the bot.
8791

8892
:::warning
8993

90-
If you are using SSH and run the file, your bot will not stay running. This is because the file is
94+
If you are using SSH to run the file, your bot will not stay running. This is because the file is
9195
only told to run during your session. You can use a command like [nohup](https://en.wikipedia.org/wiki/Nohup)
9296
to make sure your file stays running after you disconnect.
9397

docs/Getting-Started/rules-and-common-practices.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: Rules and Common Practices
55
# Rules and Common Practices of Creating a Bot
66

77
When creating almost anything, there's always a certain set of rules to follow or common practices,
8-
such as (PEP8)[https://www.python.org/dev/peps/pep-0008/] for Python. This applies for creating bots
8+
such as [PEP8](https://www.python.org/dev/peps/pep-0008/) for Python. This applies for creating bots
99
with Pycord as well.
1010

1111
:::note
@@ -56,12 +56,12 @@ about it. I'm here to tell you that it isn't a good idea to shard your bot.
5656

5757
*Wait a minute, why would it be an option if it wasn't a good idea?* It's simple. I lied. Sort of.
5858
I'm not going to go into the details of sharding a bot, so you can read about it on
59-
[this page](../Topics/sharding.mdx). Basically, though, sharding is the process of taking your bot
59+
[this page](../Popular-Topics/sharding). Basically, though, sharding is the process of taking your bot
6060
and breaking it up into small pieces so it's easier to perform tasks. This is very useful for large
6161
bots, as it makes them faster and more reliable. Sharding is not a good practice for small bots.
6262

6363
:::note
64-
Discord itself will actually notify you once your bot is ready for sharding.
64+
Discord will notify you once it is time to shard your bot, and will eventually force you to do so.
6565
:::
6666

6767
At the very least, wait for one thousand servers to shard your bot. If you shard your bot while it's
@@ -85,18 +85,18 @@ While it may take some time, subclassing a bot is very worth it. Once again, thi
8585
elsewhere so I won't go into the details, but I felt it fit here so I put it here.
8686

8787
Subclassing a bot makes it more flexible and allows it to do a lot more. Read more about subclassing
88-
bots [here](../Topics/subclassing-bots.mdx)
88+
bots [here](../Topics/subclassing-bots)
8989

9090
### Your Bot's Token
9191

9292
Your bot is only able to be run for one reason: its token. If you followed the
93-
[guide for creating your first bot](creating-your-first-bot.mdx), you should already know a bit about
93+
[guide for creating your first bot](creating-your-first-bot), you should already know a bit about
9494
keeping that token safe. That's exactly what you want to do.
9595

9696
Sharing your token is never good. If someone evil gets a hold of your token, they can do terrible things,
9797
such as making your bot leave all of its servers, spamming all of the members the bot has contact with,
9898
and even manipulating the servers the bot is in, if given the permissions. That's why it's very important
99-
to keep your token safe. To learn how to do so, read [this part](creating-your-first-bot.mdx#Tokens) of
99+
to keep your token safe. To learn how to do so, read [this part](creating-your-first-bot#Tokens) of
100100
the Creating Your First Bot guide.
101101

102102
### Backups

docs/Interactions/buttons.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ So, let's see how you can add buttons to your bot!
2525

2626
Buttons weren't the only update to the interactions system in Discord. Discord also added drop-down menus, called Select Menus. Discord is also still working on more interaction elements!
2727

28-
These UI elements reside in a "view". To learn more about views, please refer to the (interactions page.)[index.mdx]
28+
These UI elements reside in a "view". To learn more about views, please refer to the [interactions page.](index)
2929

3030
## Usage Syntax
3131

@@ -299,7 +299,7 @@ That is up to you. Buttons do provide a cleaner interface for your bot, and are
299299

300300
:::info Related Topics
301301

302-
- [Slash Commands](slash-commands.mdx)
303-
- [Interactions Index](index.mdx)
302+
- [Slash Commands](slash-commands)
303+
- [Interactions Index](index)
304304

305305
:::

docs/Interactions/context-menus.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ async def is_this_msg_sus(ctx, message: discord.Message): # message commands re
109109

110110
:::info Related Topics
111111

112-
- [Slash Commands](slash-commands.mdx)
113-
- [Interactions Index](index.mdx)
112+
- [Slash Commands](slash-commands)
113+
- [Interactions Index](index)
114114

115115
:::

docs/Interactions/dropdowns.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Menus. This guide will show you the easy and painless ways of using them with Py
1111

1212
## Concept
1313

14-
Select Menus aren't the only message component in Discord. There are also [Buttons](buttons.mdx) and
15-
[Text Modals](modals.mdx). Select Menus make it easy for users to pick one or multiple options from
14+
Select Menus aren't the only message component in Discord. There are also [Buttons](buttons) and
15+
[Text Modals](modals). Select Menus make it easy for users to pick one or multiple options from
1616
a list provided by a bot.
1717

1818
```py
@@ -101,7 +101,7 @@ skills, as Pycord requires a bit of Python experience.
101101

102102
:::info Related Topics
103103

104-
- [Slash Commands](slash-commands.mdx)
105-
- [Interactions Index](index.mdx)
104+
- [Slash Commands](slash-commands)
105+
- [Interactions Index](index)
106106

107107
:::

docs/Interactions/index.mdx

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ import "@discord-message-components/react/styles";
1414
Back in the December 2020, Discord released their first interaction: the slash command.
1515
Since then, Discord has added and updated Interactions a lot. Different types of Interactions are:
1616

17-
****Message Components****
17+
**Message Components**
1818

1919
- **Buttons**: buttons that can be clicked on to perform an action
2020
- **Select Menus**: Dropdowns used to select an option from a list of options
2121
- **Modals**: Form-like modals that can be used to ask for input
2222

23-
****Application Commands****
23+
**Application Commands**
2424

2525
- **Slash Commands**: Commands that can be used to perform an action
2626
- **Context Menu Commands**
@@ -69,32 +69,33 @@ things with buttons, such as calculators, games, and more!
6969
<br />
7070

7171
This is what a Button looks like. Very simple and modern. To learn more about buttons, refer to our
72-
(buttons page)[buttons.mdx].
72+
[buttons page](buttons).
7373

7474
### Select Menus
7575

7676
Select Menus are the second of Discord's Message Components. They allow for quick choices by the
7777
user that your bot can use. Select Menus are good for things such as choosing features, pages of a
7878
help menu, and more.
7979

80-
[Insert Select Menu example]
80+
<!-- [Insert Select Menu example] -->
8181

8282
This is what a Select Menu looks like. While not looking as good as Buttons, they still look great
83-
and have even greater possibilities. To learn more about Select Menus, please refer to our (Select
84-
Menus page)[dropdowns.mdx].
83+
and have even greater possibilities. To learn more about Select Menus, please refer to our [Select
84+
Menus page](dropdowns).
8585

8686
### Text Modals
8787

8888
Text Modals are the most recent Message Component in Discord. They're useful for text input and
8989
filling out forms such as a sign-up for your bot's service. These are meant to replace long bot setup
9090
processes by allowing users to fill out a form, as well as replace having to make the user send
91-
messages that the bot uses in general. Due to the upcoming (Message Content Intent)[topics/intents.mdx],
91+
messages that the bot uses in general. Due to the upcoming [Message Content Intent](../Popular-Topics/intents),
9292
verified bots will be forced to use Discord's new interactions system instead of messages. Text Modals
9393
are opened by clicking on a button.
9494

95-
[Text Modal example?]
95+
<!-- [Text Modal example?] -->
9696

97-
This is what a Text Modal looks like. Easy to use and one of the most useful Message Components yet.
97+
This is what a Text Modal looks like. Easy to use and one of the most useful Message Components yet. To
98+
learn more about text modals, please visit our [Text Modals page](text-modals)
9899

99100
## Application Commands
100101

@@ -148,14 +149,14 @@ are useful for having a function to add a user to a ticket, warn a user, and mor
148149

149150
This is a Message Command:
150151

151-
[Message Command Example]
152+
<!-- [Message Command Example] -->
152153

153154
And this is a User Command:
154155

155-
[User Command Example]
156+
<!-- [User Command Example] -->
156157

157-
Pretty cool, right? To learn more about these two, please read the (Message and User Commands guide)
158-
[message-user-commands.mdx]
158+
Pretty cool, right? To learn more about these two, please read the [Message and User Commands guide]
159+
(message-user-commands)
159160

160161
## Application Commands vs. Prefix Commands
161162

0 commit comments

Comments
 (0)