add more docs

botisimo · Jun 14, 2020 · ef2764c · ef2764c
1 parent 1670577
commit ef2764c
Show file tree

Hide file tree

Showing 57 changed files with 206 additions and 64 deletions.
diff --git a/docs/commands/custom/index.rst b/docs/commands/custom/index.rst
@@ -0,0 +1,16 @@
+Custom
+======
+
+Custom commands are commands created by you.
+
+Custom command responses are often made up of text that combines :doc:`response variables <../../variables/index>` and :doc:`response directives <../../directives/index>` to achieve dynamic output.
+
+You can create custom commands by visiting the `commands page <https://botisimo.com/account/commands>`_ and clicking on **"+ Create New"**.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-commands-custom
+   :caption: Related Commands
+
+   ../default/command
+   ../default/commands
diff --git a/docs/commands/amazon.rst → docs/commands/default/amazon.rst b/docs/commands/amazon.rst → docs/commands/default/amazon.rst
diff --git a/docs/commands/bridge.rst → docs/commands/default/bridge.rst b/docs/commands/bridge.rst → docs/commands/default/bridge.rst
diff --git a/docs/commands/buy.rst → docs/commands/default/buy.rst b/docs/commands/buy.rst → docs/commands/default/buy.rst
diff --git a/docs/commands/clear.rst → docs/commands/default/clear.rst b/docs/commands/clear.rst → docs/commands/default/clear.rst
diff --git a/docs/commands/clip.rst → docs/commands/default/clip.rst b/docs/commands/clip.rst → docs/commands/default/clip.rst
diff --git a/docs/commands/command.rst → docs/commands/default/command.rst b/docs/commands/command.rst → docs/commands/default/command.rst
diff --git a/docs/commands/commands.rst → docs/commands/default/commands.rst b/docs/commands/commands.rst → docs/commands/default/commands.rst
diff --git a/docs/commands/currency.rst → docs/commands/default/currency.rst b/docs/commands/currency.rst → docs/commands/default/currency.rst
diff --git a/docs/commands/enter.rst → docs/commands/default/enter.rst b/docs/commands/enter.rst → docs/commands/default/enter.rst
diff --git a/docs/commands/game.rst → docs/commands/default/game.rst b/docs/commands/game.rst → docs/commands/default/game.rst
diff --git a/docs/commands/gameall.rst → docs/commands/default/gameall.rst b/docs/commands/gameall.rst → docs/commands/default/gameall.rst
diff --git a/docs/commands/give.rst → docs/commands/default/give.rst b/docs/commands/give.rst → docs/commands/default/give.rst
diff --git a/docs/commands/giveaway.rst → docs/commands/default/giveaway.rst b/docs/commands/giveaway.rst → docs/commands/default/giveaway.rst
diff --git a/docs/commands/help.rst → docs/commands/default/help.rst b/docs/commands/help.rst → docs/commands/default/help.rst
diff --git a/docs/commands/default/index.rst b/docs/commands/default/index.rst
@@ -0,0 +1,63 @@
+Default
+=======
+
+Default commands are the commands that come built-in to Botisimo. See below for the complete list. Click on any command to see how it works.
+
+You can change the minimum permissions or disable any of the default commands by visiting the `commands page <https://botisimo.com/account/commands>`_ and clicking on "Edit Default Command Permissions".
+
+.. note::
+
+    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
+
+.. note::
+
+    If viewers are not receiving whispers from Botisimo in Twitch, they may need to send it a whisper first to get it working for their account.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-commands-default
+
+   amazon
+   bridge
+   buy
+   clear
+   clip
+   command
+   commands
+   currency
+   enter
+   game
+   gameall
+   give
+   giveaway
+   help
+   irregular
+   leaderboard
+   leave
+   link
+   live
+   music
+   nextsong
+   optin
+   optout
+   permit
+   ping
+   poll
+   prefix
+   queue
+   rank
+   reddit
+   regular
+   shop
+   songrequest
+   stackoverflow
+   subscribe
+   timer
+   title
+   titleall
+   twitter
+   unsubscribe
+   uptime
+   vote
+   wikipedia
+   winner
diff --git a/docs/commands/irregular.rst → docs/commands/default/irregular.rst b/docs/commands/irregular.rst → docs/commands/default/irregular.rst
diff --git a/docs/commands/leaderboard.rst → docs/commands/default/leaderboard.rst b/docs/commands/leaderboard.rst → docs/commands/default/leaderboard.rst
diff --git a/docs/commands/leave.rst → docs/commands/default/leave.rst b/docs/commands/leave.rst → docs/commands/default/leave.rst
diff --git a/docs/commands/link.rst → docs/commands/default/link.rst b/docs/commands/link.rst → docs/commands/default/link.rst
diff --git a/docs/commands/live.rst → docs/commands/default/live.rst b/docs/commands/live.rst → docs/commands/default/live.rst
diff --git a/docs/commands/login.rst → docs/commands/default/login.rst b/docs/commands/login.rst → docs/commands/default/login.rst
diff --git a/docs/commands/logout.rst → docs/commands/default/logout.rst b/docs/commands/logout.rst → docs/commands/default/logout.rst
diff --git a/docs/commands/music.rst → docs/commands/default/music.rst b/docs/commands/music.rst → docs/commands/default/music.rst
diff --git a/docs/commands/nextsong.rst → docs/commands/default/nextsong.rst b/docs/commands/nextsong.rst → docs/commands/default/nextsong.rst
diff --git a/docs/commands/optin.rst → docs/commands/default/optin.rst b/docs/commands/optin.rst → docs/commands/default/optin.rst
diff --git a/docs/commands/optout.rst → docs/commands/default/optout.rst b/docs/commands/optout.rst → docs/commands/default/optout.rst
diff --git a/docs/commands/permit.rst → docs/commands/default/permit.rst b/docs/commands/permit.rst → docs/commands/default/permit.rst
diff --git a/docs/commands/ping.rst → docs/commands/default/ping.rst b/docs/commands/ping.rst → docs/commands/default/ping.rst
diff --git a/docs/commands/playlists.rst → docs/commands/default/playlists.rst b/docs/commands/playlists.rst → docs/commands/default/playlists.rst
diff --git a/docs/commands/poll.rst → docs/commands/default/poll.rst b/docs/commands/poll.rst → docs/commands/default/poll.rst
diff --git a/docs/commands/prefix.rst → docs/commands/default/prefix.rst b/docs/commands/prefix.rst → docs/commands/default/prefix.rst
diff --git a/docs/commands/queue.rst → docs/commands/default/queue.rst b/docs/commands/queue.rst → docs/commands/default/queue.rst
diff --git a/docs/commands/rank.rst → docs/commands/default/rank.rst b/docs/commands/rank.rst → docs/commands/default/rank.rst
diff --git a/docs/commands/reddit.rst → docs/commands/default/reddit.rst b/docs/commands/reddit.rst → docs/commands/default/reddit.rst
diff --git a/docs/commands/regular.rst → docs/commands/default/regular.rst b/docs/commands/regular.rst → docs/commands/default/regular.rst
diff --git a/docs/commands/shop.rst → docs/commands/default/shop.rst b/docs/commands/shop.rst → docs/commands/default/shop.rst
diff --git a/docs/commands/songrequest.rst → docs/commands/default/songrequest.rst b/docs/commands/songrequest.rst → docs/commands/default/songrequest.rst
diff --git a/docs/commands/stackoverflow.rst → docs/commands/default/stackoverflow.rst b/docs/commands/stackoverflow.rst → docs/commands/default/stackoverflow.rst
diff --git a/docs/commands/subscribe.rst → docs/commands/default/subscribe.rst b/docs/commands/subscribe.rst → docs/commands/default/subscribe.rst
diff --git a/docs/commands/timer.rst → docs/commands/default/timer.rst b/docs/commands/timer.rst → docs/commands/default/timer.rst
diff --git a/docs/commands/title.rst → docs/commands/default/title.rst b/docs/commands/title.rst → docs/commands/default/title.rst
diff --git a/docs/commands/titleall.rst → docs/commands/default/titleall.rst b/docs/commands/titleall.rst → docs/commands/default/titleall.rst
diff --git a/docs/commands/twitter.rst → docs/commands/default/twitter.rst b/docs/commands/twitter.rst → docs/commands/default/twitter.rst
diff --git a/docs/commands/unsubscribe.rst → docs/commands/default/unsubscribe.rst b/docs/commands/unsubscribe.rst → docs/commands/default/unsubscribe.rst
diff --git a/docs/commands/uptime.rst → docs/commands/default/uptime.rst b/docs/commands/uptime.rst → docs/commands/default/uptime.rst
diff --git a/docs/commands/vote.rst → docs/commands/default/vote.rst b/docs/commands/vote.rst → docs/commands/default/vote.rst
diff --git a/docs/commands/wikipedia.rst → docs/commands/default/wikipedia.rst b/docs/commands/wikipedia.rst → docs/commands/default/wikipedia.rst
diff --git a/docs/commands/winner.rst → docs/commands/default/winner.rst b/docs/commands/winner.rst → docs/commands/default/winner.rst
diff --git a/docs/commands/index.rst b/docs/commands/index.rst
@@ -1,61 +1,11 @@
 Commands
 ========
 
-Commands are used to allow you and your moderators/users to interact with the bot via chat.
-
-.. note::
-
-    If a command argument is required it will be wrapped in ``<`` ``>`` and if the argument is optional it will be wrapped in ``[`` ``]``.
-
-.. note::
-
-    If viewers are not receiving whispers from Botisimo in Twitch, they may need to send it a whisper first to get it working for their account.
+Commands are used to allow you, your moderators, and your viewers to interact with the bot via chat. Default commands are the commands that come built-in to Botisimo. Custom commands are commands created by you.
 
 .. toctree::
    :maxdepth: 1
    :name: toc-commands
 
-   amazon
-   bridge
-   buy
-   clear
-   clip
-   command
-   commands
-   currency
-   enter
-   game
-   gameall
-   give
-   giveaway
-   help
-   irregular
-   leaderboard
-   leave
-   link
-   live
-   music
-   nextsong
-   optin
-   optout
-   permit
-   ping
-   poll
-   prefix
-   queue
-   rank
-   reddit
-   regular
-   shop
-   songrequest
-   stackoverflow
-   subscribe
-   timer
-   title
-   titleall
-   twitter
-   unsubscribe
-   uptime
-   vote
-   wikipedia
-   winner
+   default/index
+   custom/index
diff --git a/docs/directives/index.rst b/docs/directives/index.rst
@@ -1,7 +1,7 @@
 Directives
 ==========
 
-Response directives are used to make dynamic actions for your `custom commands <https://botisimo.com/account/commands>`_. Directives will be processed after :doc:`response variables </variables/index>` and in the order they appear in the response text.
+Response directives are used to make dynamic actions for your `custom commands <https://botisimo.com/account/commands>`_ and `timers <https://botisimo.com/account/timers>`_. Directives will be processed after :doc:`response variables <variables/index>` and in the order they appear in the response text.
 
 .. note::
 

diff --git a/docs/giveaways/index.rst b/docs/giveaways/index.rst
@@ -0,0 +1,14 @@
+Giveaways
+=========
+
+Giveaways are used to reward your viewers. This is a great way to give back to your viewers for supporting you. Giveaways are often used to give a random viewer gift card codes or in-game items.
+
+You can create giveaways by visiting the `giveaways page <https://botisimo.com/account/giveaways>`_ and clicking on **"+ Create New"**.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-giveaways
+   :caption: Related Commands
+
+   ../commands/default/giveaway
+   ../commands/default/enter
diff --git a/docs/index.rst b/docs/index.rst
@@ -29,9 +29,9 @@ Many features of Botisimo require moderator privileges in your channel. It is hi
 Commands
 ^^^^^^^^
 
-Commands are used to allow you and your moderators/users to interact with the bot via chat.
+Commands are used to allow you, your moderators, and your viewers to interact with the bot via chat.
 
-:doc:`View All Commands → <commands/index>`
+:doc:`Learn About Commands → <commands/index>`
 
 .. toctree::
    :maxdepth: 1
@@ -40,12 +40,68 @@ Commands are used to allow you and your moderators/users to interact with the bo
 
    commands/index
 
-Variables
+Timers
+^^^^^^
+
+Timers are used to automate messages based on time interval and chat activity. This is a great way to promote your brand and your message. Timers are often used to do things like promote social media channels or remind people to like, follow, and subscribe to your streaming channel so they know when you are going to be live next.
+
+:doc:`Learn About Timers → <timers/index>`
+
+.. toctree::
+   :maxdepth: 1
+   :name: sec-timers
+   :hidden:
+
+   timers/index
+
+Polls
+^^^^^
+
+Polls are used to get feedback from your viewers. Polls are often used to do things like ask viewers what game you should play or how many times they think you will win a battle today.
+
+:doc:`Learn About Polls → <polls/index>`
+
+.. toctree::
+   :maxdepth: 1
+   :name: sec-polls
+   :hidden:
+
+   polls/index
+
+Giveaways
 ^^^^^^^^^
 
-Response variables are used to make dynamic `custom command <https://botisimo.com/account/commands>`_ responses.
+Giveaways are used to reward your viewers. This is a great way to give back to your viewers for supporting you. Giveaways are often used to give a random viewer gift card codes or in-game items.
 
-:doc:`View All Variables → <variables/index>`
+:doc:`Learn About Giveaways → <giveaways/index>`
+
+.. toctree::
+   :maxdepth: 1
+   :name: sec-giveaways
+   :hidden:
+
+   giveaways/index
+
+Shop
+^^^^
+
+The shop is used to incentivize your viewers to watch and participate in your stream regularly. When viewers watch your stream they gets currency that they can spend in your shop. The shop often includes items like a personal shout out or maybe you have to do something silly like the ice bucket challenge, be creative.
+
+:doc:`Learn About Shop → <shop/index>`
+
+.. toctree::
+   :maxdepth: 1
+   :name: sec-shop
+   :hidden:
+
+   shop/index
+
+Response Variables
+^^^^^^^^^^^^^^^^^^
+
+Response variables are used to make dynamic `custom command <https://botisimo.com/account/commands>`_ and `timer <https://botisimo.com/account/timers>`_ responses.
+
+:doc:`View Response Variables → <variables/index>`
 
 .. toctree::
    :maxdepth: 1
@@ -54,12 +110,12 @@ Response variables are used to make dynamic `custom command <https://botisimo.co
 
    variables/index
 
-Directives
-^^^^^^^^^^
+Response Directives
+^^^^^^^^^^^^^^^^^^^
 
-Response directives are used to make dynamic actions for your `custom commands <https://botisimo.com/account/commands>`_. Directives will be processed after :doc:`response variables <variables/index>` and in the order they appear in the response text.
+Response directives are used to make dynamic actions for your `custom commands <https://botisimo.com/account/commands>`_ and `timers <https://botisimo.com/account/timers>`_. Directives will be processed after :doc:`response variables <variables/index>` and in the order they appear in the response text.
 
-:doc:`View All Directives → <directives/index>`
+:doc:`View Response Directives → <directives/index>`
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/polls/index.rst b/docs/polls/index.rst
@@ -0,0 +1,14 @@
+Polls
+=====
+
+Polls are used to get feedback from your viewers. Polls are often used to ask viewers what game we should play or how many times they think I will win a battle today.
+
+You can create polls by visiting the `polls page <https://botisimo.com/account/polls>`_ and clicking on **"+ Create New"**.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-polls
+   :caption: Related Commands
+
+   ../commands/default/poll
+   ../commands/default/vote
diff --git a/docs/shop/index.rst b/docs/shop/index.rst
@@ -0,0 +1,14 @@
+Shop
+====
+
+The shop is used to incentivize your viewers to watch and participate in your stream regularly. When viewers watch your stream they gets currency that they can spend in your shop. The shop often includes items like a personal shout out or maybe you have to do something silly like the ice bucket challenge, be creative.
+
+You can create shop items by visiting the `shop page <https://botisimo.com/account/shop>`_ and clicking on **"+ Create New"**.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-shop
+   :caption: Related Commands
+
+   ../commands/default/shop
+   ../commands/default/buy
diff --git a/docs/timers/index.rst b/docs/timers/index.rst
@@ -0,0 +1,15 @@
+Timers
+======
+
+Timers are used to automate messages based on time interval and chat activity. This is a great way to promote your brand and your message. Timers are often used to do things like promote social media channels or remind people to like, follow, and subscribe so they know when you are going to be live next.
+
+Timer responses are often made up of text that combines :doc:`response variables <../../variables/index>` and :doc:`response directives <../../directives/index>` to achieve dynamic output.
+
+You can create timers by visiting the `timers page <https://botisimo.com/account/timers>`_ and clicking on **"+ Create New"**.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-timers
+   :caption: Related Commands
+
+   ../commands/default/timer
diff --git a/docs/variables/index.rst b/docs/variables/index.rst
@@ -1,7 +1,7 @@
 Variables
 =========
 
-Response variables are used to make dynamic `custom command <https://botisimo.com/account/commands>`_ responses. See also :doc:`response directives </directives/index>`.
+Response variables are used to make dynamic `custom command <https://botisimo.com/account/commands>`_ and `timer <https://botisimo.com/account/timers>`_ responses. See also :doc:`response directives </directives/index>`.
 
 .. note::