From fdf1ad529be775fafce67bba49516a250a3d231b Mon Sep 17 00:00:00 2001 From: Tyler Date: Sun, 11 Jun 2017 01:10:19 -0400 Subject: [PATCH] Update documentation --- docs/commands/index.rst | 2 +- docs/commands/location.rst | 4 ++-- docs/commands/media.rst | 12 +++++------ docs/commands/poll.rst | 38 +++++++++++++++++++++++++++++++++ docs/commands/sysadmin.rst | 14 ++++++++++++ docs/commands/utils.rst | 34 +++++++++++++++++++++++++++++ docs/features/content.rst | 12 +++++------ docs/features/messages.rst | 6 +++--- docs/features/overwatch.rst | 10 ++++----- docs/features/overwatch_pug.rst | 10 ++++----- docs/setup.rst | 2 +- 11 files changed, 115 insertions(+), 29 deletions(-) create mode 100644 docs/commands/poll.rst create mode 100644 docs/commands/sysadmin.rst create mode 100644 docs/commands/utils.rst diff --git a/docs/commands/index.rst b/docs/commands/index.rst index 1659af4..ea5cab0 100644 --- a/docs/commands/index.rst +++ b/docs/commands/index.rst @@ -16,4 +16,4 @@ Voice Commands are matched by full words/blocks of text, such as holding down th Text Commands ------------- -Text Commands can be done in any channel with the prefix `!!` (two exclamation points). \ No newline at end of file +Text Commands can be done in any channel with the prefix `!` (one exclamation point). \ No newline at end of file diff --git a/docs/commands/location.rst b/docs/commands/location.rst index cf37ee8..bf96c6d 100644 --- a/docs/commands/location.rst +++ b/docs/commands/location.rst @@ -8,9 +8,9 @@ Setting your location can provide responses to many commands that are tailored t To set your location, use the following text command: - !!location city/state/country + !location city/state/country -We use Google's Location API to resolve this to a Latitude/Longitude, which you can get by using `!!location` without any arguments after setting it. +We use Google's Location API to resolve this to a Latitude/Longitude, which you can get by using `!location` without any arguments after setting it. Time diff --git a/docs/commands/media.rst b/docs/commands/media.rst index f702e6d..af0970d 100644 --- a/docs/commands/media.rst +++ b/docs/commands/media.rst @@ -14,16 +14,16 @@ Playing media can be done using the voice command You can also add YouTube videos directly using the text command: - !!play + !play Controlling the queue --------------------- -Queue items can be skipped by saying `skip` or using the text command `!!skip`. +Queue items can be skipped by saying `skip` or using the text command `!skip`. -The queue can be cleared by using the text command `!!clear`. This will not skip the current song. +The queue can be cleared by using the text command `!clear`. This will not skip the current song. -To stop playback and clear the queue, say `stop` or use the text command `!!stop`. +To stop playback and clear the queue, say `stop` or use the text command `!stop`. Adjusting the volume -------------------- @@ -34,7 +34,7 @@ Adjusting the volume can be done using the voice command: Or the text command: - !!volume 0-100 + !volume 0-100 You can also say `louder` or `softer` to raise/lower the volume by 10% each time. @@ -43,4 +43,4 @@ Setting the default volume |project|'s default volume can be set for voice and media. The sane values of 100% for voice, and 20% for audio are used. When the command is used without arguments, it will show the current values. - !!defaultvolume 0-100 \ No newline at end of file + !defaultvolume 0-100 \ No newline at end of file diff --git a/docs/commands/poll.rst b/docs/commands/poll.rst new file mode 100644 index 0000000..145a996 --- /dev/null +++ b/docs/commands/poll.rst @@ -0,0 +1,38 @@ +Poll Commands +============= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +Starting a poll +--------------- + +To start a standard poll, use the following command: + + !poll "" "option1" "option2"... + +There can be as many options as you want. + +Starting a timed poll +--------------------- + +A timed poll will automatically end after the specified time limit (in minutes) + +To start a timed poll, use the following command: + + !tpoll "question"