From 0ca9bbaec846dfe1351fe45a734d8ddc7530268d Mon Sep 17 00:00:00 2001 From: KubaZ2 Date: Tue, 1 Oct 2024 16:46:17 +0200 Subject: [PATCH] Update image descriptions and revise bot instructions Updated image descriptions across multiple documentation files to provide more context. Revised instructions in `coding.md` for obtaining and copying the bot token. Revised instructions in `creating-a-first-bot.md` for creating an application and adding a bot to a server. --- Documentation/guides/advanced/http-interactions.md | 2 +- Documentation/guides/events/intents.md | 2 +- Documentation/guides/getting-started/coding.md | 12 ++++++++---- .../guides/getting-started/creating-a-first-bot.md | 14 ++++++++++---- .../guides/getting-started/installation.md | 8 ++++---- 5 files changed, 24 insertions(+), 14 deletions(-) diff --git a/Documentation/guides/advanced/http-interactions.md b/Documentation/guides/advanced/http-interactions.md index d1e56af62..8e851c11e 100644 --- a/Documentation/guides/advanced/http-interactions.md +++ b/Documentation/guides/advanced/http-interactions.md @@ -16,7 +16,7 @@ To handle HTTP interactions, you need to use @NetCord.Hosting.Rest.RestClientSer To make your bot receive interactions, you need to store the public key in the configuration and specify the endpoint URL in the [Discord Developer Portal](https://discord.com/developers/applications). -![](../../images/httpInteractions_FindingPublicKeyAndSpecifyingInteractionEndpointUrl.png) +![Shows 'Public Key' section in 'General Information' section](../../images/httpInteractions_FindingPublicKeyAndSpecifyingInteractionEndpointUrl.png) ### Specifying Public Key in Configuration diff --git a/Documentation/guides/events/intents.md b/Documentation/guides/events/intents.md index d3ebaa44a..105bf2b43 100644 --- a/Documentation/guides/events/intents.md +++ b/Documentation/guides/events/intents.md @@ -5,7 +5,7 @@ Intents allow you to subscribe Discord events, such as @NetCord.Gateway.GatewayC ## Privileged intents Privileged intents are intents that you need to enable in [Discord Developer Portal](https://discord.com/developers/applications). -![](../../images/intents_Privileged.png) +![Shows 'Privileged Gateway Intents' section in 'Bot' section](../../images/intents_Privileged.png) ## How to specify intents in NetCord? diff --git a/Documentation/guides/getting-started/coding.md b/Documentation/guides/getting-started/coding.md index 9ed8188dc..06b418d49 100644 --- a/Documentation/guides/getting-started/coding.md +++ b/Documentation/guides/getting-started/coding.md @@ -4,8 +4,12 @@ > This section assumes that you have a project with NetCord installed and you have a bot created. If not, go back! Before we start, you need a token of your bot... so you need to go to the [Discord Developer Portal](https://discord.com/developers/applications) and get it. -![](../../images/coding_Token_1.png) -![](../../images/coding_Token_2.png) + +- Go to `Bot` section and click `Reset Token`. + ![Go to 'Bot' section and click 'Reset Token'](../../images/coding_Token_1.png) + +- Then click `Copy` to copy the token to the clipboard. + ![Click 'Copy' to copy the token to the clipboard](../../images/coding_Token_2.png) > [!IMPORTANT] > You should never give your token to anybody. @@ -19,7 +23,7 @@ Also note that the token needs to be stored in the configuration. You can for ex [!code-json[appsettings.json](CodingHosting/appsettings.json)] Now, when you run the code, your bot should be online! -![](../../images/coding_BotOnline.png) +![Bot being online](../../images/coding_BotOnline.png) ## [Bare Bones](#tab/bare-bones) @@ -33,7 +37,7 @@ Now it's time to finally... make the bot online! To do it, add the following lin [!code-cs[Program.cs](Coding/Program.cs#L12-L13)] Now, when you run the code, your bot should be online! -![](../../images/coding_BotOnline.png) +![Bot being online](../../images/coding_BotOnline.png) ### The Final Product [!code-cs[Program.cs](Coding/Program.cs)] diff --git a/Documentation/guides/getting-started/creating-a-first-bot.md b/Documentation/guides/getting-started/creating-a-first-bot.md index 0aa8b7658..cb0bbe4f7 100644 --- a/Documentation/guides/getting-started/creating-a-first-bot.md +++ b/Documentation/guides/getting-started/creating-a-first-bot.md @@ -1,9 +1,15 @@ # Creating a First Bot! 1. Go to [Discord Developer Portal](https://discord.com/developers/applications). + 2. Create an app. -![](../../images/creatingFirstBot_CreateApplication_1.png) -![](../../images/creatingFirstBot_CreateApplication_2.png) + - Click `New Application`. + ![Click 'New Application'](../../images/creatingFirstBot_CreateApplication_1.png) + - Fill the name and check the checkbox and click `Create`. + ![Fill the name and check the checkbox and click 'Create'](../../images/creatingFirstBot_CreateApplication_2.png) + 3. Add the bot to a server. Copy a link, and then paste the link to a browser and add the bot! -![](../../images/creatingFirstBot_AddBotToServer.png) -![](../../images/creatingFirstBot_AddBotToServer_2.png) + - Go to `OAuth2 > URL Generator`, select `bot` scope and click `Copy` to copy the bot invite link. + ![Click 'OAuth2 > URL Generator', select 'bot' scope and click 'Copy' to copy the bot invite link](../../images/creatingFirstBot_AddBotToServer.png) + - Paste the link to a browser, select the server to add the bot and click `Authorize`. + ![Paste the link to a browser, select the server to add the bot and click 'Authorize'](../../images/creatingFirstBot_AddBotToServer_2.png) diff --git a/Documentation/guides/getting-started/installation.md b/Documentation/guides/getting-started/installation.md index bc9569c61..dc5eb1bae 100644 --- a/Documentation/guides/getting-started/installation.md +++ b/Documentation/guides/getting-started/installation.md @@ -9,14 +9,14 @@ 2. Click `Manage NuGet Packages`. - ![](../../images/installation_VisualStudio_1.png) + ![Click 'Manage NuGet Packages'](../../images/installation_VisualStudio_1.png) 3. Browse and install `NetCord` package. > [!NOTE] > The `Include prerelease` checkbox must be checked to see the package. - ![](../../images/installation_VisualStudio_2.png) + ![Browse and install 'NetCord' package](../../images/installation_VisualStudio_2.png) ## [JetBrains Rider](#tab/rider) @@ -24,14 +24,14 @@ 2. Click `Manage NuGet Packages`. - ![](../../images/installation_JetBrainsRider_1.png) + ![Click 'Manage NuGet Packages'](../../images/installation_JetBrainsRider_1.png) 3. Browse and install `NetCord` package. > [!NOTE] > The `Prerelease` checkbox must be checked to see the package. - ![](../../images/installation_JetBrainsRider_2.png) + ![Browse and install 'NetCord' package](../../images/installation_JetBrainsRider_2.png) ## [Other](#tab/other)