Skip to content

Commit d28e58b

Browse files
committed
Add using-the-bot
1 parent e6b5f11 commit d28e58b

File tree

6 files changed

+73
-5
lines changed

6 files changed

+73
-5
lines changed

docs/discord-bot/hosting-the-bot/hosting-on-pterodactyl.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Proceed only if you have the Pterodactyl hosting panel.
2121

2222
1. If you didn't add the Python Egg into the Panel, do so now.
2323
2. Create a new server with the Python Egg.
24-
3. Use a random port for the API, it does not matter
24+
3. Use a random port for the API, it does not matter.
2525
4. Give it at least 256MB of RAM.
2626
5. After the server is created and the auto-installation has completed, put in the Bot files from [Our Repository](https://bpsapi.rajtech.me/r/discord-bot)
2727
6. You may need to connect through SFTP to upload the folders and the `data.db` file.
2828
7. Make sure the main bot file is `bot.py`
2929
8. Configure `./data/config.ini` to your liking.
30-
9. Click the run button. It should start running
30+
9. Click the run button. It should start running.
3131

3232
There you go! Your Discord Bot is now running and ready to use.

docs/discord-bot/hosting-the-bot/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In this section, you will learn how to get the environment ready to run the Disc
1010

1111
You'll need a dedicated server that runs 24/7, to keep the bot up at all times.
1212

13-
If you don't have one, you can always use the [Ready-Made Bot](url).
13+
If you don't have one, you can always use the [Ready-Made Bot](../using-the-bot/intro).
1414

1515
:::
1616

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Using the Discord Bot",
3+
"position": 2,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "Learn to use and host the Discord Bot"
7+
}
8+
}
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Bot Commands
6+
Our Discord Bot has **3** main commands!
7+
8+
There are three circular categories. `General`, `PTM` and `Exam`.
9+
10+
## User Commands
11+
:::tip TIP
12+
13+
Normal user commands are prefixed with `/circular`
14+
15+
:::
16+
17+
`/circular latest [category]`: Get the latest circular of one of the three Circular categories.
18+
19+
`/circular list [category]`: Get the whole circular list (all the circulars) of one of the three Circular categories.
20+
21+
`/circular search [circular name]`: Look for a specific circular whose title keywords you remember. Example: Searching `mobile` finds and gives you the `Mobile Phone Usage Policy` circular, and it's details.
22+
23+
24+
## Server Administrator Commands
25+
26+
:::tip TIP
27+
28+
Server administrator commands start with `/circular admin`.
29+
30+
:::
31+
32+
`/circular admin setup [channel]`: Subscribe a channel for the listener for when a new circular is posted.
33+
34+
`/circular admin delete`: Delete the subscription for the listener for when a new circular is posted.
35+
36+
-----
37+
Thanks for reading! if you would like more support or help feel free to contact me at `Raj Dave#3215`
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Introduction
6+
7+
:::tip Tip!
8+
9+
Here's the invite link to the bot - **https://bpsapi.rajtech.me/r/discord-bot-invite**
10+
11+
:::
12+
13+
The **BPS Circular Bot** is a Simple, Public and [Open Source](https://bpsapi.rajtech.me/r/discord-bot) Discord Bot made using [Our API](https://rajtech.me/docs/category/using-the-api/intro). It runs 24/7 on reliable servers, and is completely free to use.
14+
15+
This page is an introduction to its features.
16+
17+
## Features
18+
19+
The bot has many features, which include:
20+
1. Send a configurable message in a channel automatically, whenever a new circular is posted on the BPS Website
21+
2. Get a Discord Image Preview and download link of the latest circular (per category basis) with `/circular latest`
22+
3. Get the list of all circulars in a nice-looking embed with `/circular list`
23+
4. Search for ANY circular which is present, on the BPS website. Just with a few keywords like `mobile`, right through Discord. And get its Image Preview, Name, and Download URL!
24+

docusaurus.config.js

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,7 @@ const config = {
3838

3939
// Please change this to your repo.
4040
// Remove this to remove the "edit this page" links.
41-
editUrl:
42-
'https://github.com/BPS-Circular-API/docs-page',
41+
// editUrl: 'https://github.com/BPS-Circular-API/docs-page/edit/main',
4342
},
4443
blog: false,
4544
theme: {

0 commit comments

Comments
 (0)