Browse Source

Restructure documentation layout

tags/1.0.0-rc2
Christopher F 8 years ago
parent
commit
5ade1e387b
41 changed files with 22 additions and 33 deletions
  1. +1
    -0
      docs/CONTRIBUTING.md
  2. +0
    -0
      docs/guides/commands/commands.md
  3. +0
    -0
      docs/guides/commands/samples/command_handler.cs
  4. +0
    -0
      docs/guides/commands/samples/dependency_map_setup.cs
  5. +0
    -0
      docs/guides/commands/samples/dependency_module.cs
  6. +0
    -0
      docs/guides/commands/samples/empty-module.cs
  7. +0
    -0
      docs/guides/commands/samples/groups.cs
  8. +0
    -0
      docs/guides/commands/samples/module.cs
  9. +0
    -0
      docs/guides/commands/samples/require_owner.cs
  10. +0
    -0
      docs/guides/commands/samples/typereader.cs
  11. +0
    -0
      docs/guides/concepts/events.md
  12. +0
    -0
      docs/guides/concepts/logging.md
  13. +0
    -0
      docs/guides/concepts/samples/logging.cs
  14. +0
    -0
      docs/guides/getting_started/images/install-vs-deps.png
  15. +0
    -0
      docs/guides/getting_started/images/install-vs-nuget.png
  16. +0
    -0
      docs/guides/getting_started/images/intro-add-bot.png
  17. +0
    -0
      docs/guides/getting_started/images/intro-client-id.png
  18. +0
    -0
      docs/guides/getting_started/images/intro-create-app.png
  19. +0
    -0
      docs/guides/getting_started/images/intro-create-bot.png
  20. +0
    -0
      docs/guides/getting_started/images/intro-token.png
  21. +0
    -0
      docs/guides/getting_started/installing.md
  22. +0
    -0
      docs/guides/getting_started/intro.md
  23. +0
    -0
      docs/guides/getting_started/samples/intro/async-context.cs
  24. +0
    -0
      docs/guides/getting_started/samples/intro/client.cs
  25. +0
    -0
      docs/guides/getting_started/samples/intro/complete.cs
  26. +0
    -0
      docs/guides/getting_started/samples/intro/logging.cs
  27. +0
    -0
      docs/guides/getting_started/samples/intro/message.cs
  28. +0
    -0
      docs/guides/getting_started/samples/intro/structure.cs
  29. +0
    -0
      docs/guides/getting_started/samples/netstd11.cs
  30. +0
    -0
      docs/guides/getting_started/samples/nuget.config
  31. +0
    -0
      docs/guides/getting_started/samples/project.csproj
  32. +0
    -0
      docs/guides/getting_started/terminology.md
  33. +0
    -0
      docs/guides/migrating/migrating.md
  34. +0
    -0
      docs/guides/migrating/samples/event.cs
  35. +0
    -0
      docs/guides/migrating/samples/sync_event.cs
  36. +16
    -15
      docs/guides/toc.yml
  37. +0
    -0
      docs/guides/voice/samples/audio_create_ffmpeg.cs
  38. +0
    -0
      docs/guides/voice/samples/audio_ffmpeg.cs
  39. +0
    -0
      docs/guides/voice/samples/joining_audio.cs
  40. +5
    -16
      docs/guides/voice/sending-voice.md
  41. +0
    -2
      docs/toc.yml

+ 1
- 0
docs/CONTRIBUTING.md View File

@@ -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:



docs/guides/commands.md → docs/guides/commands/commands.md View File


docs/guides/samples/command_handler.cs → docs/guides/commands/samples/command_handler.cs View File


docs/guides/samples/dependency_map_setup.cs → docs/guides/commands/samples/dependency_map_setup.cs View File


docs/guides/samples/dependency_module.cs → docs/guides/commands/samples/dependency_module.cs View File


docs/guides/samples/empty-module.cs → docs/guides/commands/samples/empty-module.cs View File


docs/guides/samples/groups.cs → docs/guides/commands/samples/groups.cs View File


docs/guides/samples/module.cs → docs/guides/commands/samples/module.cs View File


docs/guides/samples/require_owner.cs → docs/guides/commands/samples/require_owner.cs View File


docs/guides/samples/typereader.cs → docs/guides/commands/samples/typereader.cs View File


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


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


docs/guides/samples/logging.cs → docs/guides/concepts/samples/logging.cs View File


docs/guides/images/install-vs-deps.png → docs/guides/getting_started/images/install-vs-deps.png View File


docs/guides/images/install-vs-nuget.png → docs/guides/getting_started/images/install-vs-nuget.png View File


docs/guides/images/intro-add-bot.png → docs/guides/getting_started/images/intro-add-bot.png View File


docs/guides/images/intro-client-id.png → docs/guides/getting_started/images/intro-client-id.png View File


docs/guides/images/intro-create-app.png → docs/guides/getting_started/images/intro-create-app.png View File


docs/guides/images/intro-create-bot.png → docs/guides/getting_started/images/intro-create-bot.png View File


docs/guides/images/intro-token.png → docs/guides/getting_started/images/intro-token.png View File


docs/guides/installing.md → docs/guides/getting_started/installing.md View File


docs/guides/intro.md → docs/guides/getting_started/intro.md View File


docs/guides/samples/intro/async-context.cs → docs/guides/getting_started/samples/intro/async-context.cs View File


docs/guides/samples/intro/client.cs → docs/guides/getting_started/samples/intro/client.cs View File


docs/guides/samples/intro/complete.cs → docs/guides/getting_started/samples/intro/complete.cs View File


docs/guides/samples/intro/logging.cs → docs/guides/getting_started/samples/intro/logging.cs View File


docs/guides/samples/intro/message.cs → docs/guides/getting_started/samples/intro/message.cs View File


docs/guides/samples/intro/structure.cs → docs/guides/getting_started/samples/intro/structure.cs View File


docs/guides/samples/netstd11.cs → docs/guides/getting_started/samples/netstd11.cs View File


docs/guides/samples/nuget.config → docs/guides/getting_started/samples/nuget.config View File


docs/guides/samples/project.csproj → docs/guides/getting_started/samples/project.csproj View File


docs/guides/terminology.md → docs/guides/getting_started/terminology.md View File


docs/migrating.md → docs/guides/migrating/migrating.md View File


docs/guides/samples/migrating/event.cs → docs/guides/migrating/samples/event.cs View File


docs/guides/samples/migrating/sync_event.cs → docs/guides/migrating/samples/sync_event.cs View File


+ 16
- 15
docs/guides/toc.yml View File

@@ -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

docs/guides/samples/audio_create_ffmpeg.cs → docs/guides/voice/samples/audio_create_ffmpeg.cs View File


docs/guides/samples/audio_ffmpeg.cs → docs/guides/voice/samples/audio_ffmpeg.cs View File


docs/guides/samples/joining_audio.cs → docs/guides/voice/samples/joining_audio.cs View File


docs/guides/voice.md → docs/guides/voice/sending-voice.md View File

@@ -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

+ 0
- 2
docs/toc.yml View File

@@ -1,8 +1,6 @@

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

Loading…
Cancel
Save