Skip to content

Commit

Permalink
docs: Docs/updating discord docs (#481)
Browse files Browse the repository at this point in the history
* docs: updated discord docs

Added two images and changed the spacing to get the list to render properly.

* docs: added warning about message-intent

* docs: discord bot - new images and instructions

* docs: sourcing guild and channel ids

* docs: added bot verification image

* docs: update spacing on ordered list

* docs: updates

---------

Co-authored-by: Chris Schroeder <32779673+theMultitude@users.noreply.github.com>
  • Loading branch information
nolanjacobson and theMultitude authored Aug 6, 2024
1 parent e3845ec commit ebbf1e8
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
6 changes: 3 additions & 3 deletions docs/oracle-node/discord-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ The Service Manager assesses the request and delegates the task to the appropria

To get all guilds (and their IDs) you can use the `/data/discord/guilds/all` endpoint.

> ![Get Guilds](/docs/images/discord-get-all-guilds.png)
> ![Get Guilds](/img/discord-get-all-guilds.png)
With the guild ID you can then use the `/data/discord/guilds/{guildID}/channels` endpoint to get all channels for that guild.

> ![Get Channels](/docs/images/discord-get-guild-channels.png)
> ![Get Channels](/img/discord-get-guild-channels.png)
With the guild ID you can then use the `/data/discord/guilds/{guildID}/channels` endpoint to get all channels for that guild.

Expand Down Expand Up @@ -77,7 +77,7 @@ Example response:

> **Important**: To retrieve message content, you must toggle "Message Content Intent" in the Discord Developer Portal under the `Bot` section.
>
> ![Message Content Intent](/docs/images/discord-message-content-intent.png)
> ![Message Content Intent](/img/discord-message-content-intent.png)
The `/data/discord/channels/{channelID}/messages` endpoint retrieves messages from a specified Discord channel.

Expand Down
3 changes: 2 additions & 1 deletion docs/oracle-node/discord-sentiment.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ The sentiment analysis process begins by collecting Discord messages based on sp

> **Important**: To retrieve message content, you must toggle "Message Content Intent" in the Discord Developer Portal under the `Bot` section.
>
> ![Message Content Intent](/docs/images/discord-message-content-intent.png)
> ![Message Content Intent](/img/discord-message-content-intent.png)

### Models

Expand Down
14 changes: 7 additions & 7 deletions docs/worker-node/discord-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,47 +40,47 @@ To start processing Discord data requests, you need to retrieve your Discord bot

3 . Click on the "New Application" button. Give your application a name and confirm the creation.

> ![Create a New Application](/docs/images/discord-create-a-new-application.png)
> ![Create a New Application](/img/discord-create-a-new-application.png)
### Update Bot permissions and install

1 . Go to the “Guild Install” section

2 . Select on dropdown where is says “applications.commands and select “bot”

> ![Update Bot Permissions](/docs/images/discord-change-bot-permissions.png)
> ![Update Bot Permissions](/img/discord-change-bot-permissions.png)
3 . On the added permission dropdown after selecting bot, select “administrator”

4 . Save changes on the bottom floating bar.

> ![Save Bot Permissions](/docs/images/discord-change-bot-permissions-2.png)
> ![Save Bot Permissions](/img/discord-change-bot-permissions-2.png)
5 . Copy the install link

> ![Copy Install Link](/docs/images/discord-install-link.png)
> ![Copy Install Link](/img/discord-install-link.png)
6 . Go to a new tab on your browser and paste the link and then hit enter

7 . You will go to Discord and see a modal click on add to server

8 . Select add to server dropdown and select the guild to add your new bot to your guild.

> ![Add Bot to Server](/docs/images/discord-add-bot-to-server.png)
> ![Add Bot to Server](/img/discord-add-bot-to-server.png)
9 . Click “Continue”

10 . Click Authorize to add your bot. Congrats screen and should see Bot on Discord now!

> ![Bot Added](/docs/images/discord-verify-bot.png)
> ![Bot Added](/img/discord-verify-bot.png)
### Retrieving Your Discord Bot Token

1 . Navigate to the "Bot" tab on the left-hand side and click on "Reset Token".

2 . Under the "TOKEN" section, click on "Copy" to get your bot token.

> ![Copy Token](/docs/images/discord-copy-bot-token.png)
> ![Copy Token](/img/discord-copy-bot-token.png)
### Adding Discord Credentials

Expand Down

0 comments on commit ebbf1e8

Please sign in to comment.