diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 695475dfa..296b6d1cb 100644 --- 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: diff --git a/docs/guides/commands.md b/docs/guides/commands/commands.md similarity index 100% rename from docs/guides/commands.md rename to docs/guides/commands/commands.md diff --git a/docs/guides/samples/command_handler.cs b/docs/guides/commands/samples/command_handler.cs similarity index 100% rename from docs/guides/samples/command_handler.cs rename to docs/guides/commands/samples/command_handler.cs diff --git a/docs/guides/samples/dependency_map_setup.cs b/docs/guides/commands/samples/dependency_map_setup.cs similarity index 100% rename from docs/guides/samples/dependency_map_setup.cs rename to docs/guides/commands/samples/dependency_map_setup.cs diff --git a/docs/guides/samples/dependency_module.cs b/docs/guides/commands/samples/dependency_module.cs similarity index 100% rename from docs/guides/samples/dependency_module.cs rename to docs/guides/commands/samples/dependency_module.cs diff --git a/docs/guides/samples/empty-module.cs b/docs/guides/commands/samples/empty-module.cs similarity index 100% rename from docs/guides/samples/empty-module.cs rename to docs/guides/commands/samples/empty-module.cs diff --git a/docs/guides/samples/groups.cs b/docs/guides/commands/samples/groups.cs similarity index 100% rename from docs/guides/samples/groups.cs rename to docs/guides/commands/samples/groups.cs diff --git a/docs/guides/samples/module.cs b/docs/guides/commands/samples/module.cs similarity index 100% rename from docs/guides/samples/module.cs rename to docs/guides/commands/samples/module.cs diff --git a/docs/guides/samples/require_owner.cs b/docs/guides/commands/samples/require_owner.cs similarity index 100% rename from docs/guides/samples/require_owner.cs rename to docs/guides/commands/samples/require_owner.cs diff --git a/docs/guides/samples/typereader.cs b/docs/guides/commands/samples/typereader.cs similarity index 100% rename from docs/guides/samples/typereader.cs rename to docs/guides/commands/samples/typereader.cs diff --git a/docs/guides/events.md b/docs/guides/concepts/events.md similarity index 100% rename from docs/guides/events.md rename to docs/guides/concepts/events.md diff --git a/docs/guides/logging.md b/docs/guides/concepts/logging.md similarity index 100% rename from docs/guides/logging.md rename to docs/guides/concepts/logging.md diff --git a/docs/guides/samples/logging.cs b/docs/guides/concepts/samples/logging.cs similarity index 100% rename from docs/guides/samples/logging.cs rename to docs/guides/concepts/samples/logging.cs diff --git a/docs/guides/images/install-vs-deps.png b/docs/guides/getting_started/images/install-vs-deps.png similarity index 100% rename from docs/guides/images/install-vs-deps.png rename to docs/guides/getting_started/images/install-vs-deps.png diff --git a/docs/guides/images/install-vs-nuget.png b/docs/guides/getting_started/images/install-vs-nuget.png similarity index 100% rename from docs/guides/images/install-vs-nuget.png rename to docs/guides/getting_started/images/install-vs-nuget.png diff --git a/docs/guides/images/intro-add-bot.png b/docs/guides/getting_started/images/intro-add-bot.png similarity index 100% rename from docs/guides/images/intro-add-bot.png rename to docs/guides/getting_started/images/intro-add-bot.png diff --git a/docs/guides/images/intro-client-id.png b/docs/guides/getting_started/images/intro-client-id.png similarity index 100% rename from docs/guides/images/intro-client-id.png rename to docs/guides/getting_started/images/intro-client-id.png diff --git a/docs/guides/images/intro-create-app.png b/docs/guides/getting_started/images/intro-create-app.png similarity index 100% rename from docs/guides/images/intro-create-app.png rename to docs/guides/getting_started/images/intro-create-app.png diff --git a/docs/guides/images/intro-create-bot.png b/docs/guides/getting_started/images/intro-create-bot.png similarity index 100% rename from docs/guides/images/intro-create-bot.png rename to docs/guides/getting_started/images/intro-create-bot.png diff --git a/docs/guides/images/intro-token.png b/docs/guides/getting_started/images/intro-token.png similarity index 100% rename from docs/guides/images/intro-token.png rename to docs/guides/getting_started/images/intro-token.png diff --git a/docs/guides/installing.md b/docs/guides/getting_started/installing.md similarity index 100% rename from docs/guides/installing.md rename to docs/guides/getting_started/installing.md diff --git a/docs/guides/intro.md b/docs/guides/getting_started/intro.md similarity index 100% rename from docs/guides/intro.md rename to docs/guides/getting_started/intro.md diff --git a/docs/guides/samples/intro/async-context.cs b/docs/guides/getting_started/samples/intro/async-context.cs similarity index 100% rename from docs/guides/samples/intro/async-context.cs rename to docs/guides/getting_started/samples/intro/async-context.cs diff --git a/docs/guides/samples/intro/client.cs b/docs/guides/getting_started/samples/intro/client.cs similarity index 100% rename from docs/guides/samples/intro/client.cs rename to docs/guides/getting_started/samples/intro/client.cs diff --git a/docs/guides/samples/intro/complete.cs b/docs/guides/getting_started/samples/intro/complete.cs similarity index 100% rename from docs/guides/samples/intro/complete.cs rename to docs/guides/getting_started/samples/intro/complete.cs diff --git a/docs/guides/samples/intro/logging.cs b/docs/guides/getting_started/samples/intro/logging.cs similarity index 100% rename from docs/guides/samples/intro/logging.cs rename to docs/guides/getting_started/samples/intro/logging.cs diff --git a/docs/guides/samples/intro/message.cs b/docs/guides/getting_started/samples/intro/message.cs similarity index 100% rename from docs/guides/samples/intro/message.cs rename to docs/guides/getting_started/samples/intro/message.cs diff --git a/docs/guides/samples/intro/structure.cs b/docs/guides/getting_started/samples/intro/structure.cs similarity index 100% rename from docs/guides/samples/intro/structure.cs rename to docs/guides/getting_started/samples/intro/structure.cs diff --git a/docs/guides/samples/netstd11.cs b/docs/guides/getting_started/samples/netstd11.cs similarity index 100% rename from docs/guides/samples/netstd11.cs rename to docs/guides/getting_started/samples/netstd11.cs diff --git a/docs/guides/samples/nuget.config b/docs/guides/getting_started/samples/nuget.config similarity index 100% rename from docs/guides/samples/nuget.config rename to docs/guides/getting_started/samples/nuget.config diff --git a/docs/guides/samples/project.csproj b/docs/guides/getting_started/samples/project.csproj similarity index 100% rename from docs/guides/samples/project.csproj rename to docs/guides/getting_started/samples/project.csproj diff --git a/docs/guides/terminology.md b/docs/guides/getting_started/terminology.md similarity index 100% rename from docs/guides/terminology.md rename to docs/guides/getting_started/terminology.md diff --git a/docs/migrating.md b/docs/guides/migrating/migrating.md similarity index 100% rename from docs/migrating.md rename to docs/guides/migrating/migrating.md diff --git a/docs/guides/samples/migrating/event.cs b/docs/guides/migrating/samples/event.cs similarity index 100% rename from docs/guides/samples/migrating/event.cs rename to docs/guides/migrating/samples/event.cs diff --git a/docs/guides/samples/migrating/sync_event.cs b/docs/guides/migrating/samples/sync_event.cs similarity index 100% rename from docs/guides/samples/migrating/sync_event.cs rename to docs/guides/migrating/samples/sync_event.cs diff --git a/docs/guides/toc.yml b/docs/guides/toc.yml index 308293d1e..4a2c4d2da 100644 --- 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 \ No newline at end of file +- name: Migrating from 0.9 \ No newline at end of file diff --git a/docs/guides/samples/audio_create_ffmpeg.cs b/docs/guides/voice/samples/audio_create_ffmpeg.cs similarity index 100% rename from docs/guides/samples/audio_create_ffmpeg.cs rename to docs/guides/voice/samples/audio_create_ffmpeg.cs diff --git a/docs/guides/samples/audio_ffmpeg.cs b/docs/guides/voice/samples/audio_ffmpeg.cs similarity index 100% rename from docs/guides/samples/audio_ffmpeg.cs rename to docs/guides/voice/samples/audio_ffmpeg.cs diff --git a/docs/guides/samples/joining_audio.cs b/docs/guides/voice/samples/joining_audio.cs similarity index 100% rename from docs/guides/samples/joining_audio.cs rename to docs/guides/voice/samples/joining_audio.cs diff --git a/docs/guides/voice.md b/docs/guides/voice/sending-voice.md similarity index 86% rename from docs/guides/voice.md rename to docs/guides/voice/sending-voice.md index 1f09069f5..f1ca3d0a5 100644 --- a/docs/guides/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 diff --git a/docs/toc.yml b/docs/toc.yml index 47a8a22c1..c08e708bf 100644 --- 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