From c271b02841c648f41b00868de2729d60d98327f4 Mon Sep 17 00:00:00 2001 From: Still Hsu <341464@gmail.com> Date: Tue, 19 Jun 2018 04:55:17 +0800 Subject: [PATCH] Cleanup TOC & fix titles --- docs/guides/commands/post-execution.md | 2 +- docs/guides/commands/preconditions.md | 4 ++-- docs/guides/concepts/connections.md | 6 ++++-- docs/guides/{concepts => deployment}/deployment.md | 4 ++-- docs/guides/getting_started/first-bot.md | 2 +- docs/guides/toc.yml | 6 +++--- 6 files changed, 13 insertions(+), 11 deletions(-) rename docs/guides/{concepts => deployment}/deployment.md (98%) diff --git a/docs/guides/commands/post-execution.md b/docs/guides/commands/post-execution.md index 76bade254..eb06adde4 100644 --- a/docs/guides/commands/post-execution.md +++ b/docs/guides/commands/post-execution.md @@ -3,7 +3,7 @@ uid: Guides.Commands.PostExecution title: Post-command Execution Handling --- -# Preface +# Post-execution Handling for Commands When developing commands, you may want to consider building a post-execution handling system so you can have finer control diff --git a/docs/guides/commands/preconditions.md b/docs/guides/commands/preconditions.md index 27fa1d20d..c3d72c483 100644 --- a/docs/guides/commands/preconditions.md +++ b/docs/guides/commands/preconditions.md @@ -28,7 +28,7 @@ a command method signature as an attribute. [!code-csharp[Precondition usage](samples/preconditions/precondition_usage.cs)] -### ORing Preconditions +## ORing Preconditions When writing commands, you may want to allow some of them to be executed when only some of the precondition checks are passed. @@ -38,7 +38,7 @@ handy. By assigning two or more preconditions to a group, the command system will allow the command to be executed when one of the precondition passes. -#### Example - ORing Preconditions +### Example - ORing Preconditions [!code-csharp[OR Precondition](samples/preconditions/group_precondition.cs)] diff --git a/docs/guides/concepts/connections.md b/docs/guides/concepts/connections.md index 99ea45756..3d7b77cb8 100644 --- a/docs/guides/concepts/connections.md +++ b/docs/guides/concepts/connections.md @@ -3,11 +3,13 @@ uid: Guides.Concepts.ManageConnections title: Managing Connections --- +# Managing Connections with Discord.Net + In Discord.Net, once a client has been started, it will automatically maintain a connection to Discord's gateway until it is manually stopped. -### Usage +## Usage To start a connection, invoke the `StartAsync` method on a client that supports a WebSocket connection; to end a connection, invoke the @@ -37,7 +39,7 @@ sync and has a completed guild cache. [!code-csharp[Connection Sample](samples/events.cs)] -### Reconnection +## Reconnection > [!TIP] > Avoid running long-running code on the gateway! If you deadlock the diff --git a/docs/guides/concepts/deployment.md b/docs/guides/deployment/deployment.md similarity index 98% rename from docs/guides/concepts/deployment.md rename to docs/guides/deployment/deployment.md index eea747817..b75628dc0 100644 --- a/docs/guides/concepts/deployment.md +++ b/docs/guides/deployment/deployment.md @@ -1,9 +1,9 @@ --- -uid: Guides.Concepts.Deployment +uid: Guides.Deployment title: Deploying the Bot --- -# Deploying the Bot +# Deploying a Discord.Net Bot After finishing your application, you may want to deploy your bot to a remote location such as a Virtual Private Server (VPS) or another diff --git a/docs/guides/getting_started/first-bot.md b/docs/guides/getting_started/first-bot.md index 1faa1d9e6..f23e133f4 100644 --- a/docs/guides/getting_started/first-bot.md +++ b/docs/guides/getting_started/first-bot.md @@ -3,7 +3,7 @@ uid: Guides.GettingStarted.FirstBot title: Start making a bot --- -# Making a Ping-Pong bot +# Making Your First Bot with Discord.Net One of the ways to get started with the Discord API is to write a basic ping-pong bot. This bot will respond to a simple command "ping." diff --git a/docs/guides/toc.yml b/docs/guides/toc.yml index 639fe9d88..7e771313e 100644 --- a/docs/guides/toc.yml +++ b/docs/guides/toc.yml @@ -18,9 +18,7 @@ topicUid: Guides.Concepts.ManageConnections - name: Entities topicUid: Guides.Concepts.Entities - - name: Deployment - topicUid: Guides.Concepts.Deployment -- name: The Command Service +- name: Working with Commands items: - name: Introduction topicUid: Guides.Commands.Intro @@ -34,3 +32,5 @@ topicUid: Guides.Commands.PostExecution - name: Voice topicUid: Guides.Voice.SendingVoice +- name: Deployment + topicUid: Guides.Deployment \ No newline at end of file