Restructure documentation layout

2017-04-03 16:36:26 -04:00
parent b4c3427ed1
commit 5ade1e387b
41 changed files with 22 additions and 33 deletions
--- a/docs/CONTRIBUTING.md
+++ b/docs/CONTRIBUTING.md
@@ -25,6 +25,7 @@ Style consistencies:

 * Use a ruler set at 70 characters
 * Links should use long syntax
+* Pages should be short and concise, not broad and long

 Example of long link syntax:

--- a/docs/guides/commands/commands.md
+++ b/docs/guides/commands/commands.md
--- a/docs/guides/commands/samples/command_handler.cs
+++ b/docs/guides/commands/samples/command_handler.cs
--- a/docs/guides/commands/samples/dependency_map_setup.cs
+++ b/docs/guides/commands/samples/dependency_map_setup.cs
--- a/docs/guides/commands/samples/dependency_module.cs
+++ b/docs/guides/commands/samples/dependency_module.cs
--- a/docs/guides/commands/samples/empty-module.cs
+++ b/docs/guides/commands/samples/empty-module.cs
--- a/docs/guides/commands/samples/groups.cs
+++ b/docs/guides/commands/samples/groups.cs
--- a/docs/guides/commands/samples/module.cs
+++ b/docs/guides/commands/samples/module.cs
--- a/docs/guides/commands/samples/require_owner.cs
+++ b/docs/guides/commands/samples/require_owner.cs
--- a/docs/guides/commands/samples/typereader.cs
+++ b/docs/guides/commands/samples/typereader.cs
--- a/docs/guides/concepts/events.md
+++ b/docs/guides/concepts/events.md
--- a/docs/guides/concepts/logging.md
+++ b/docs/guides/concepts/logging.md
--- a/docs/guides/concepts/samples/logging.cs
+++ b/docs/guides/concepts/samples/logging.cs
--- a/docs/guides/getting_started/images/install-vs-deps.png
+++ b/docs/guides/getting_started/images/install-vs-deps.png
--- a/docs/guides/getting_started/images/install-vs-nuget.png
+++ b/docs/guides/getting_started/images/install-vs-nuget.png
--- a/docs/guides/getting_started/images/intro-add-bot.png
+++ b/docs/guides/getting_started/images/intro-add-bot.png
--- a/docs/guides/getting_started/images/intro-client-id.png
+++ b/docs/guides/getting_started/images/intro-client-id.png
--- a/docs/guides/getting_started/images/intro-create-app.png
+++ b/docs/guides/getting_started/images/intro-create-app.png
--- a/docs/guides/getting_started/images/intro-create-bot.png
+++ b/docs/guides/getting_started/images/intro-create-bot.png
--- a/docs/guides/getting_started/images/intro-token.png
+++ b/docs/guides/getting_started/images/intro-token.png
--- a/docs/guides/getting_started/installing.md
+++ b/docs/guides/getting_started/installing.md
--- a/docs/guides/getting_started/intro.md
+++ b/docs/guides/getting_started/intro.md
--- a/docs/guides/getting_started/samples/intro/async-context.cs
+++ b/docs/guides/getting_started/samples/intro/async-context.cs
--- a/docs/guides/getting_started/samples/intro/client.cs
+++ b/docs/guides/getting_started/samples/intro/client.cs
--- a/docs/guides/getting_started/samples/intro/complete.cs
+++ b/docs/guides/getting_started/samples/intro/complete.cs
--- a/docs/guides/getting_started/samples/intro/logging.cs
+++ b/docs/guides/getting_started/samples/intro/logging.cs
--- a/docs/guides/getting_started/samples/intro/message.cs
+++ b/docs/guides/getting_started/samples/intro/message.cs
--- a/docs/guides/getting_started/samples/intro/structure.cs
+++ b/docs/guides/getting_started/samples/intro/structure.cs
--- a/docs/guides/getting_started/samples/netstd11.cs
+++ b/docs/guides/getting_started/samples/netstd11.cs
--- a/docs/guides/getting_started/samples/nuget.config
+++ b/docs/guides/getting_started/samples/nuget.config
--- a/docs/guides/getting_started/samples/project.csproj
+++ b/docs/guides/getting_started/samples/project.csproj
--- a/docs/guides/getting_started/terminology.md
+++ b/docs/guides/getting_started/terminology.md
--- a/docs/guides/migrating/migrating.md
+++ b/docs/guides/migrating/migrating.md
--- a/docs/guides/migrating/samples/event.cs
+++ b/docs/guides/migrating/samples/event.cs
--- a/docs/guides/migrating/samples/sync_event.cs
+++ b/docs/guides/migrating/samples/sync_event.cs
--- a/docs/guides/toc.yml
+++ b/docs/guides/toc.yml
@@ -1,17 +1,18 @@
-
- name: Installing
-  href: installing.md
 - name: Getting Started
-  href: intro.md
- name: Terminology
-  href: terminology.md
- name: Logging
-  href: logging.md
- name: Commands
-  href: commands.md
+  items:
+    - name: Installation
+      href: getting_started/installing.md
+    - name: Your First Bot
+      href: getting_started/intro.md
+    - name: Terminology
+      href: getting_started/terminology.md
+- name: Basic Concepts
+  items:
+    - name: Logging Data
+      href: concepts/logging.md
+    - name: Working with Events
+      href: concepts/events.md
+    - name: Entities
+- name: The Command Service
 - name: Voice
-  href: voice.md
- name: Events
-  href: events.md
- name: Code Samples
-  href: samples.md
+- name: Migrating from 0.9
--- a/docs/guides/voice/samples/audio_create_ffmpeg.cs
+++ b/docs/guides/voice/samples/audio_create_ffmpeg.cs
--- a/docs/guides/voice/samples/audio_ffmpeg.cs
+++ b/docs/guides/voice/samples/audio_ffmpeg.cs
--- a/docs/guides/voice/samples/joining_audio.cs
+++ b/docs/guides/voice/samples/joining_audio.cs
--- a/docs/guides/voice/sending-voice.md
+++ b/docs/guides/voice/sending-voice.md
@@ -1,24 +1,13 @@
-# Voice
+---
+title: Sending Voice
+---

 **Information on this page is subject to change!**

 >[!WARNING]
->Audio in 1.0 is incomplete. Most of the below documentation is untested.
+>Audio in 1.0 is in progress

-## Installation
-
-To use Audio, you must first configure your [DiscordSocketClient] 
-with Audio support.
-
-In your [DiscordSocketConfig], set `AudioMode` to the appropriate 
-[AudioMode] for your bot. For most bots, you will only need to use 
-`AudioMode.Outgoing`.
-
-[DiscordSocketClient]: xref:Discord.WebSocket.DiscordSocketClient
-[DiscordSocketConfig]: xref:Discord.WebSocket.DiscordSocketConfig
-[AudioMode]: xref:Discord.Audio.AudioMode
-
-### Dependencies
+## Installing

 Audio requires two native libraries, `libsodium` and `opus`. 
 Both of these libraries must be placed in the runtime directory of your 
--- a/docs/toc.yml
+++ b/docs/toc.yml
@@ -1,8 +1,6 @@

 - name: Guides
  href: guides/
- name: Migrating
-  href: migrating.md
 - name: API Documentation
  href: api/
  homepage: api/index.md