[Docs] General updates (#103)

docs/cogs/anotherpingcog.rst

@@ -70,6 +70,28 @@ pingset
 
 Manage settings - emojis, embed colour, and force embed.
 
+.. _anotherpingcog-command-pingset-footer:
+
+""""""""""""""
+pingset footer
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]pingset footer <text>
+
+**Description**
+
+Set a custom footer for the ping embed.
+
+If ``none`` is provided as the parameter, there will be no embed footer.
+
+If ``default`` is provided as the parameter, the default footer will be used.
+
+Otherwise, the provided text will be used as the custom footer.
+
 .. _anotherpingcog-command-pingset-forceembed:
 
 """"""""""""""""""

docs/cogs/betteruptime.rst

@@ -58,6 +58,24 @@ Otherwise, it needs to be ``5`` or more.
     - ``[p]uptime 0`` (for all-time data)
     - ``[p]uptime 7``
 
+.. _betteruptime-command-resetbu:
+
+^^^^^^^
+resetbu
+^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]resetbu 
+
+**Description**
+
+Reset the cog's data.
+
 .. _betteruptime-command-uptime:
 
 ^^^^^^
@@ -77,7 +95,62 @@ Get Red's uptime percent over the last 30 days, and when I was last restarted.
 The default value for ``num_days`` is ``30``. You can put ``0`` days for all-time data.
 Otherwise, it needs to be ``5`` or more.
 
+.. Note:: embeds must be enabled for this rich data to show
+
+
 **Examples:**
     - ``[p]uptime``
     - ``[p]uptime 0`` (for all-time data)
     - ``[p]uptime 7``
+
+.. _betteruptime-command-uptimeexport:
+
+^^^^^^^^^^^^
+uptimeexport
+^^^^^^^^^^^^
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]uptimeexport 
+
+**Description**
+
+Export my uptime data to CSV
+
+The numbers represent uptime, so 86400 means 100% for that day (86400 seconds in 1 day).
+
+Everything is in UTC.
+
+Connected is the bot being connected to Discord.
+
+Cog loaded is the cog being loaded but not necessarily connected to Discord.
+
+Therefore, connected should always be equal to or lower than cog loaded.
+
+.. _betteruptime-command-uptimegraph:
+
+^^^^^^^^^^^
+uptimegraph
+^^^^^^^^^^^
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]uptimegraph [num_days=30]
+
+**Description**
+
+Check Red uptime with a graph over the last 30 days.
+
+The default value for ``num_days`` is ``30``. You can put ``0`` days for all-time data.
+Otherwise, it needs to be ``5`` or more.
+
+**Examples:**
+    - ``[p]uptime`` - for the default of 30 days
+    - ``[p]uptime 0`` - for all-time data
+    - ``[p]uptime 7`` - 7 days

docs/cogs/birthday.rst

@@ -71,6 +71,32 @@ Set the channel where the birthday message will be sent.
 **Example:**
     - ``[p]bdset channel #birthdays`` - set the channel to #birthdays
 
+.. _birthday-command-bdset-force:
+
+"""""""""""
+bdset force
+"""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bdset force <user> <birthday>
+
+**Description**
+
+Force-set a specific user's birthday.
+
+You can @ mention any user or type out their exact name. If you're typing out a name with
+spaces, make sure to put quotes around it (``"``).
+
+**Examples:**
+    - ``[p]bdset set @User 1-1-2000`` - set the birthday of ``@User`` to 1/1/2000
+    - ``[p]bdset set User 1/1`` - set the birthday of ``@User`` to 1/1/2000
+    - ``[p]bdset set "User with spaces" 1-1`` - set the birthday of ``@User with spaces``
+    to 1/1
+    - ``[p]bdset set 354125157387344896 1/1/2000`` - set the birthday of ``@User`` to 1/1/2000
+
 .. _birthday-command-bdset-interactive:
 
 """""""""""""""""
@@ -101,7 +127,9 @@ bdset msgwithoutyear
 
 **Description**
 
-Set the message to be send when the user provided a year.
+Set the message to be send when the user did not provide a year.
+
+If you would like to mention a role, you will need to run ``[p]bdset rolemention true``.
 
 **Placeholders:**
     - ``{name}`` - the user's name
@@ -129,6 +157,8 @@ bdset msgwithyear
 
 Set the message to be send when the user did provide a year.
 
+If you would like to mention a role, you will need to run ``[p]bdset rolemention true``
+
 **Placeholders:**
     - ``{name}`` - the user's name
     - ``{mention}`` - an @ mention of the user
@@ -163,6 +193,27 @@ You can give the exact name or a mention.
     - ``[p]bdset role Birthday`` - set the role to @Birthday without a mention
     - ``[p]bdset role 418058139913063657`` - set the role with an ID
 
+.. _birthday-command-bdset-rolemention:
+
+"""""""""""""""""
+bdset rolemention
+"""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bdset rolemention <value>
+
+**Description**
+
+Choose whether or not to allow role mentions in birthday messages.
+
+By default role mentions are suppressed.
+
+To allow role mentions in the birthday message, run ``[p]bdset rolemention true``.
+Disable them with ``[p]bdset rolemention true``
+
 .. _birthday-command-bdset-settings:
 
 """"""""""""""
@@ -179,6 +230,22 @@ bdset settings
 
 View your current settings
 
+.. _birthday-command-bdset-stop:
+
+""""""""""
+bdset stop
+""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bdset stop 
+
+**Description**
+
+Stop the cog from sending birthday messages and giving roles in the server.
+
 .. _birthday-command-bdset-time:
 
 """"""""""
@@ -202,6 +269,24 @@ Minutes are ignored.
     - ``[p]bdset time 12AM`` - set the time to midnight UTC
     - ``[p]bdset time 3PM`` - set the time to 3:00PM UTC
 
+.. _birthday-command-bdset-zemigrate:
+
+"""""""""""""""
+bdset zemigrate
+"""""""""""""""
+
+.. note:: |owner-lock|
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]bdset zemigrate 
+
+**Description**
+
+Import data from ZeCogs'/flare's fork of Birthdays cog
+
 .. _birthday-command-birthday:
 
 ^^^^^^^^
@@ -281,8 +366,20 @@ birthday upcoming
 
 **Description**
 
-View upcoming birthdays.
+View upcoming birthdays, defaults to 7 days.
 
 **Examples:**
     - ``[p]birthday upcoming`` - default of 7 days
     - ``[p]birthday upcoming 14`` - 14 days
+
+.. _birthday-command-birthdaydebug-upcoming:
+
+""""""""""""""""""""""
+birthdaydebug upcoming
+""""""""""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]birthdaydebug upcoming 

docs/cogs/caseinsensitive.rst

@@ -7,6 +7,8 @@ CaseInsensitive
 This is the cog guide for the caseinsensitive cog. You will
 find detailed docs about usage and commands.
 
+``[p]`` is considered as your prefix.
+
 .. note::
 
     To use this cog, you will need to install and load it.
@@ -19,18 +21,23 @@ find detailed docs about usage and commands.
 Usage
 -----
 
-This allows and commands to be case insensitive (for example ``!Ping`` would be accepted and responded to).
+This allows prefixes and commands to be case insensitive (for example ````!Ping````
+would be accepted and responded to).
+
+Whenever the cog is loaded, prefixes and commands will be case insensitive.
+This cog itself has no commands.
+
+If you want to disable it in a certain servers, use
+``[p]command disablecog CaseInsensitive``.
 
-Whenever the cog is loaded, commands will be case insensitive. This cog itself has no commands.
+There are also other configurations, such as setting a default as disabled
+and enabling per-server, listed under ``[p]help command``.
 
-If you want to disable it in a certain servers, use ``[p]command disablecog CaseInsensitive``. 
-There are also other configurations, such as setting a default as disabled and enabling per-server,
-listed under ``[p]help command``.
 
 .. _caseinsensitive-commands:
 
 --------
 Commands
 --------
 
-This cog has no commands.
+This cog has no commands. It is always active when loaded.

docs/cogs/cmdlog.rst

@@ -26,6 +26,10 @@ Log command usage in a form searchable by user ID, server ID or command name.
 The cog keeps an internal cache and everything is also logged to the bot's main logs under
 ``red.vex.cmdlog``, level INFO.
 
+The internal cache is non persistant and subsequently is lost on cog unload,
+including bot shutdowns. The logged data will last until Red's custom logging
+rotator deletes old logs.
+
 
 .. _cmdlog-commands:
 
@@ -71,6 +75,28 @@ cmdlog cache
 
 Show the size of the internal command cache.
 
+.. _cmdlog-command-cmdlog-channel:
+
+""""""""""""""
+cmdlog channel
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cmdlog channel [channel]
+
+**Description**
+
+Set the channel to send logs to, this is optional.
+
+Run the comand without a channel to stop sending.
+
+**Example:**
+    - ``[p]cmdlog channel #com-log`` - set the log channel to #com-log
+    - ``[p]cmdlog channel`` - stop sending logs
+
 .. _cmdlog-command-cmdlog-command:
 
 """"""""""""""
@@ -98,6 +124,22 @@ As arguments are not stored, you cannot search for them.
     - ``[p]cmdlog command playlist``
     - ``[p]cmdlog command playlist create``
 
+.. _cmdlog-command-cmdlog-content:
+
+""""""""""""""
+cmdlog content
+""""""""""""""
+
+**Syntax**
+
+.. code-block:: none
+
+    [p]cmdlog content <to_log>
+
+**Description**
+
+Set whether or not whole message content should be logged. Default false.
+
 .. _cmdlog-command-cmdlog-full:
 
 """""""""""