Browse Source

Cleanup TOC & fix titles

pull/1161/head
Still Hsu 7 years ago
parent
commit
c271b02841
No known key found for this signature in database GPG Key ID: 8601A145FDA95209
6 changed files with 13 additions and 11 deletions
  1. +1
    -1
      docs/guides/commands/post-execution.md
  2. +2
    -2
      docs/guides/commands/preconditions.md
  3. +4
    -2
      docs/guides/concepts/connections.md
  4. +2
    -2
      docs/guides/deployment/deployment.md
  5. +1
    -1
      docs/guides/getting_started/first-bot.md
  6. +3
    -3
      docs/guides/toc.yml

+ 1
- 1
docs/guides/commands/post-execution.md View File

@@ -3,7 +3,7 @@ uid: Guides.Commands.PostExecution
title: Post-command Execution Handling title: Post-command Execution Handling
--- ---


# Preface
# Post-execution Handling for Commands


When developing commands, you may want to consider building a When developing commands, you may want to consider building a
post-execution handling system so you can have finer control post-execution handling system so you can have finer control


+ 2
- 2
docs/guides/commands/preconditions.md View File

@@ -28,7 +28,7 @@ a command method signature as an attribute.


[!code-csharp[Precondition usage](samples/preconditions/precondition_usage.cs)] [!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 When writing commands, you may want to allow some of them to be
executed when only some of the precondition checks are passed. 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 system will allow the command to be executed when one of the
precondition passes. precondition passes.


#### Example - ORing Preconditions
### Example - ORing Preconditions


[!code-csharp[OR Precondition](samples/preconditions/group_precondition.cs)] [!code-csharp[OR Precondition](samples/preconditions/group_precondition.cs)]




+ 4
- 2
docs/guides/concepts/connections.md View File

@@ -3,11 +3,13 @@ uid: Guides.Concepts.ManageConnections
title: Managing Connections title: Managing Connections
--- ---


# Managing Connections with Discord.Net

In Discord.Net, once a client has been started, it will automatically In Discord.Net, once a client has been started, it will automatically
maintain a connection to Discord's gateway until it is manually maintain a connection to Discord's gateway until it is manually
stopped. stopped.


### Usage
## Usage


To start a connection, invoke the `StartAsync` method on a client that To start a connection, invoke the `StartAsync` method on a client that
supports a WebSocket connection; to end a connection, invoke the 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)] [!code-csharp[Connection Sample](samples/events.cs)]


### Reconnection
## Reconnection


> [!TIP] > [!TIP]
> Avoid running long-running code on the gateway! If you deadlock the > Avoid running long-running code on the gateway! If you deadlock the


docs/guides/concepts/deployment.md → docs/guides/deployment/deployment.md View File

@@ -1,9 +1,9 @@
--- ---
uid: Guides.Concepts.Deployment
uid: Guides.Deployment
title: Deploying the Bot 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 After finishing your application, you may want to deploy your bot to a
remote location such as a Virtual Private Server (VPS) or another remote location such as a Virtual Private Server (VPS) or another

+ 1
- 1
docs/guides/getting_started/first-bot.md View File

@@ -3,7 +3,7 @@ uid: Guides.GettingStarted.FirstBot
title: Start making a bot 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 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." basic ping-pong bot. This bot will respond to a simple command "ping."


+ 3
- 3
docs/guides/toc.yml View File

@@ -18,9 +18,7 @@
topicUid: Guides.Concepts.ManageConnections topicUid: Guides.Concepts.ManageConnections
- name: Entities - name: Entities
topicUid: Guides.Concepts.Entities topicUid: Guides.Concepts.Entities
- name: Deployment
topicUid: Guides.Concepts.Deployment
- name: The Command Service
- name: Working with Commands
items: items:
- name: Introduction - name: Introduction
topicUid: Guides.Commands.Intro topicUid: Guides.Commands.Intro
@@ -34,3 +32,5 @@
topicUid: Guides.Commands.PostExecution topicUid: Guides.Commands.PostExecution
- name: Voice - name: Voice
topicUid: Guides.Voice.SendingVoice topicUid: Guides.Voice.SendingVoice
- name: Deployment
topicUid: Guides.Deployment

Loading…
Cancel
Save