make docs better

botisimo · Jan 27, 2020 · a36aaa2 · a36aaa2
1 parent f1d221f
commit a36aaa2
Show file tree

Hide file tree

Showing 27 changed files with 345 additions and 176 deletions.
diff --git a/docs/commands/bridge.rst b/docs/commands/bridge.rst
@@ -3,9 +3,13 @@
 
 A Discord bridge is a way to send messages between multiple Discord servers running Botisimo. The `!bridge` command is used to create/join/leave/delete Discord bridges via chat.
 
-    - ``delete`` - Delete or leave a bridge `view docs <#delete>`_
-    - ``join`` - Join a bridge `view docs <#join>`_
-    - ``new`` - Create a new bridge to host `view docs <#new>`_
+    - ``delete`` - Delete or leave a bridge `view docs`__
+    - ``join`` - Join a bridge `view docs`__
+    - ``new`` - Create a new bridge to host `view docs`__
+
+__ #delete
+__ #join
+__ #new
 
 .. note::
 

diff --git a/docs/commands/command.rst b/docs/commands/command.rst
@@ -3,14 +3,23 @@
 
 The ``!command`` command is used to create/edit/delete/enable/disable `custom commands <https://botisimo.com/account/commands>`_ via chat.
 
-    - ``delete`` - Delete command `view docs <#delete>`_
-    - ``disable`` - Disable command `view docs <#disable>`_
-    - ``edit`` - Edit command response `view docs <#edit>`_
-    - ``enable`` - Enable command `view docs <#enable>`_
-    - ``info`` - View command info `view docs <#info>`_
-    - ``list`` - List commands `view docs <#list>`_
-    - ``new`` - Create a new command `view docs <#new>`_
-    - ``permission`` - Edit command minimum permission `view docs <#permission>`_
+    - ``delete`` - Delete command `view docs`__
+    - ``disable`` - Disable command `view docs`__
+    - ``edit`` - Edit command response `view docs`__
+    - ``enable`` - Enable command `view docs`__
+    - ``info`` - View command info `view docs`__
+    - ``list`` - List commands `view docs`__
+    - ``new`` - Create a new command `view docs`__
+    - ``permission`` - Edit command minimum permission `view docs`__
+
+__ #delete
+__ #disable
+__ #edit
+__ #enable
+__ #info
+__ #list
+__ #new
+__ #permission
 
 .. note::
 

diff --git a/docs/commands/giveaway.rst b/docs/commands/giveaway.rst
@@ -3,13 +3,21 @@
 
 The ``!giveaway`` command is used to create/view/close/end `giveaways <https://botisimo.com/account/giveaways>`_ via chat.
 
-    - ``close`` - Close entry for the current giveaway `view docs <#close>`_
-    - ``end`` - End a giveaway `view docs <#end>`_
-    - ``new`` - Create a new giveaway `view docs <#new>`_
-    - ``open`` - Open entry for the current giveaway `view docs <#open>`_
-    - ``rules`` - View the rules for the current giveaway `view docs <#rules>`_
-    - ``view`` - View current giveaway `view docs <#view>`_
-    - ``winner`` - Select a winner `view docs <#winner>`_
+    - ``close`` - Close entry for the current giveaway `view docs`__
+    - ``end`` - End a giveaway `view docs`__
+    - ``new`` - Create a new giveaway `view docs`__
+    - ``open`` - Open entry for the current giveaway `view docs`__
+    - ``rules`` - View the rules for the current giveaway `view docs`__
+    - ``view`` - View current giveaway `view docs`__
+    - ``winner`` - Select a winner `view docs`__
+
+__ #close
+__ #end
+__ #new
+__ #open
+__ #rules
+__ #view
+__ #winner
 
 .. note::
 

diff --git a/docs/commands/index.rst b/docs/commands/index.rst
@@ -0,0 +1,54 @@
+Commands
+========
+
+Commands are used to allow you and your moderators/users to interact with the bot via chat.
+
+.. 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
+
+   amazon
+   bridge
+   buy
+   clear
+   clip
+   command
+   commands
+   enter
+   game
+   gameall
+   give
+   giveaway
+   help
+   irregular
+   leaderboard
+   leave
+   link
+   live
+   nextsong
+   optin
+   optout
+   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/link.rst b/docs/commands/link.rst
@@ -3,9 +3,9 @@
 
 The ``!link`` command is used to link users from different platforms together to share currency and XP. Each group of linked users can have 1 user from each platform linked (Twitch, Mixer, YouTube, and Discord). You must have login access to the user account on each platform to be able to link them.
 
-    - `Link Users <#link-users>`_
-    - `Check Linked Users <#check-linked-users>`_
-    - `Unlink Users <#unlink-users>`_
+    - `Link Users`_
+    - `Check Linked Users`_
+    - `Unlink Users`_
 
 Link Users
 ^^^^^^^^^^

diff --git a/docs/commands/live.rst b/docs/commands/live.rst
@@ -1,7 +1,7 @@
 !live
 =====
 
-Force a stream up announcement in Discord (useful in case the automatic announcement fails)
+Force a stream up announcement in Discord (useful in case the automatic announcement fails).
 
 Usage
     !live

diff --git a/docs/commands/login.rst b/docs/commands/login.rst
@@ -0,0 +1,12 @@
+!login (Discord only)
+=====================
+
+Receive a link to authorize chat mirroring for your Discord user (platform can be ``twitch`` or ``mixer``).
+
+Usage
+    !login ``<platform>``
+
+Example
+    Request a link to authorize your Twitch account::
+
+        !login twitch
diff --git a/docs/commands/logout.rst b/docs/commands/logout.rst
@@ -0,0 +1,12 @@
+!logout (Discord only)
+======================
+
+Disable chat mirroring for your Discord user (platform can be ``twitch`` or ``mixer``).
+
+Usage
+    !logout ``<platform>``
+
+Example
+    Deauthorize your Twitch account::
+
+        !logout twitch
diff --git a/docs/commands/playlists.rst b/docs/commands/playlists.rst
@@ -0,0 +1,12 @@
+!playlists (Discord only)
+=========================
+
+List Youtube playlists from connected account (must have `connected YouTube channel <https://botisimo.com/account/connections>`_).
+
+Usage
+    !playlists
+
+Example
+    ::
+
+        !playlists
diff --git a/docs/commands/poll.rst b/docs/commands/poll.rst
@@ -3,12 +3,19 @@
 
 The ``!poll`` command is used to create/view/close/end `polls <https://botisimo.com/account/polls>`_ via chat.
 
-    - ``close`` - Close voting for a poll `view docs <#close>`_
-    - ``end`` - End a poll `view docs <#end>`_
-    - ``new`` - Create a new poll `view docs <#new>`_
-    - ``open`` - Open voting for a poll `view docs <#open>`_
-    - ``view`` - View current poll `view docs <#view>`_
-    - ``winner`` - Select a winner `view docs <#winner>`_
+    - ``close`` - Close voting for a poll `view docs`__
+    - ``end`` - End a poll `view docs`__
+    - ``new`` - Create a new poll `view docs`__
+    - ``open`` - Open voting for a poll `view docs`__
+    - ``view`` - View current poll `view docs`__
+    - ``winner`` - Select a winner `view docs`__
+
+__ #close
+__ #end
+__ #new
+__ #open
+__ #view
+__ #winner
 
 .. note::
 

diff --git a/docs/commands/queue.rst b/docs/commands/queue.rst
@@ -2,15 +2,25 @@
 ======
 The ``!queue`` command is used to join/leave/list users in the queue via chat
 
-    - ``clear`` - Clear the queue `view docs <#clear>`_
-    - ``close`` - Close the queue `view docs <#close>`_
-    - ``join`` - Join the queue `view docs <#join>`_
-    - ``leave`` - Leave the queue `view docs <#leave>`_
-    - ``list`` - List users in queue `view docs <#list>`_
-    - ``next`` - Get the next user in the queue `view docs <#next>`_
-    - ``open`` - Open the queue `view docs <#open>`_
-    - ``permission`` - Edit queue minimum permission `view docs <#permission>`_
-    - ``random`` - Gets a random user in the queue as the next user `view docs <#random>`_
+    - ``clear`` - Clear the queue `view docs`__
+    - ``close`` - Close the queue `view docs`__
+    - ``join`` - Join the queue `view docs`__
+    - ``leave`` - Leave the queue `view docs`__
+    - ``list`` - List users in queue `view docs`__
+    - ``next`` - Get the next user in the queue `view docs`__
+    - ``open`` - Open the queue `view docs`__
+    - ``permission`` - Edit queue minimum permission `view docs`__
+    - ``random`` - Gets a random user in the queue as the next user `view docs`__
+
+__ #clear
+__ #close
+__ #join
+__ #leave
+__ #list
+__ #next
+__ #open
+__ #permission
+__ #random
 
 clear
 ^^^^^

diff --git a/docs/commands/timer.rst b/docs/commands/timer.rst
@@ -3,13 +3,21 @@
 
 The ``!timer`` command is used to create/edit/delete/start/stop `custom timers <https://botisimo.com/account/timers>`_ via chat.
 
-    - ``delete`` - Delete a timer `view docs <#delete>`_
-    - ``edit`` - Edit a timer `view docs <#edit>`_
-    - ``info`` - View timer info `view docs <#info>`_
-    - ``list`` - List timers `view docs <#list>`_
-    - ``new`` - Create a new timer `view docs <#new>`_
-    - ``start`` - Start a timer `view docs <#start>`_
-    - ``stop`` - Stop a timer `view docs <#stop>`_
+    - ``delete`` - Delete a timer `view docs`__
+    - ``edit`` - Edit a timer `view docs`__
+    - ``info`` - View timer info `view docs`__
+    - ``list`` - List timers `view docs`__
+    - ``new`` - Create a new timer `view docs`__
+    - ``start`` - Start a timer `view docs`__
+    - ``stop`` - Stop a timer `view docs`__
+
+__ #delete
+__ #edit
+__ #info
+__ #list
+__ #new
+__ #start
+__ #stop
 
 .. note::
 

diff --git a/docs/directives/advanced.rst b/docs/directives/advanced.rst
@@ -1,7 +1,7 @@
 Advanced Example
 ================
 
-This example shows you how to combine the ``$(pick)`` and ``$(repeat)`` `response variables </variables>`_ with the ``$[cost]`` and ``$[give]`` response directives to make a !gamble command.
+This example shows you how to combine the ``$(pick)`` and ``$(repeat)`` :doc:`response variables </variables/index>` with the ``$[cost]`` and ``$[give]`` :doc:`response directives</directives/index>` to make a !gamble command.
 
 Example
     This command will cost the user ``100`` currency to run and will give them a 5:16 chance to break even, a 5:16 chance to lose it, a 5:16 chance to get a return, and a 1:16 chance to hit the jackpot::

diff --git a/docs/directives/cache.rst b/docs/directives/cache.rst
@@ -1,7 +1,7 @@
 $[cache]
 ========
 
-Saves a value temporarily to be used in other commands. Fetch values from the cache using the `cache variable </variables/cache>`_. The cache is not meant to be used as a long term or permanent place to store any sensitive or important information. This cache could be reset at any time without warning.
+Saves a value temporarily to be used in other commands. Fetch values from the cache using the :doc:`cache variable </variables/cache>`. The cache is not meant to be used as a long term or permanent place to store any sensitive or important information. This cache could be reset at any time without warning.
 
 Usage
     $[cache ``<key>`` ``<seconds>`` ``<value>``]

diff --git a/docs/directives/index.rst b/docs/directives/index.rst
@@ -0,0 +1,27 @@
+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.
+
+.. toctree::
+   :maxdepth: 1
+   :name: toc-directives
+
+   cache
+   chain
+   cooldown
+   cost
+   delay
+   delete
+   discord
+   event
+   give
+   hours
+   norelay
+   precooldown
+   precost
+   predelay
+   prehours
+   transfer
+   whisper
+   advanced
diff --git a/docs/directives/precooldown.rst b/docs/directives/precooldown.rst
@@ -1,4 +1,4 @@
 $[precooldown]
 ==============
 
-Same as `$[cooldown] </directives/cooldown>`_ but applied before parsing `command variables </variables>`_.
+Same as :doc:`$[cooldown] </directives/cooldown>` but applied before parsing :doc:`command variables </variables/index>`.
diff --git a/docs/directives/precost.rst b/docs/directives/precost.rst
@@ -1,4 +1,4 @@
 $[precost]
 ==========
 
-Same as `$[cost] </directives/cost>`_ but applied before parsing `command variables </variables>`_.
+Same as :doc:`$[cost] </directives/cost>` but applied before parsing :doc:`command variables </variables/index>`.
diff --git a/docs/directives/predelay.rst b/docs/directives/predelay.rst
@@ -1,4 +1,4 @@
 $[predelay]
 ===========
 
-Same as `$[delay] </directives/delay>`_ but applied before parsing `command variables </variables>`_.
+Same as :doc:`$[delay] </directives/delay>` but applied before parsing :doc:`command variables </variables/index>`.
diff --git a/docs/directives/prehours.rst b/docs/directives/prehours.rst
@@ -1,4 +1,4 @@
 $[prehours]
 ===========
 
-Same as `$[hours] </directives/hours>`_ but applied before parsing `command variables </variables>`_.
+Same as :doc:`$[hours] </directives/hours>` but applied before parsing :doc:`command variables </variables/index>`.