CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2025-11-06 03:08:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Getting started guide: fix incorrect information / typos (#5180)

Browse Source
This commit is contained in:
Kreus Amredes 2021-08-29 14:26:13 +01:00 committed by GitHub
parent ec5428f1e9
commit ee0627f41f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/getting_started.rst
View File

@ -26,8 +26,8 @@ window like this:
Invite Red to your server Invite Red to your server
------------------------- -------------------------
When started, the console will show you ``Invite URL`` (here at When started, the console will show you the ``Invite URL``
the bottom of the screenshot). (visible at the bottom of the screenshot above).
Paste the link into your browser and select the server you want Paste the link into your browser and select the server you want
to invite the bot in, like any other bot. to invite the bot in, like any other bot.
@ -63,7 +63,7 @@ example, if your prefix is ``!``, you will execute your command like this:
The commands The commands
~~~~~~~~~~~~ ~~~~~~~~~~~~
The command you're going to use the most is help. That command will The command you're going to use the most is **help**. This command will
show you **all of the available commands** of the bot with a small description. show you **all of the available commands** of the bot with a small description.
.. code-block:: none .. code-block:: none
@ -106,8 +106,8 @@ parameters.
the syntax ``cleanup messages <number> [delete_pinned=False]``, which means the syntax ``cleanup messages <number> [delete_pinned=False]``, which means
``delete_pinned`` default will be false, unless you specify it as true. ``delete_pinned`` default will be false, unless you specify it as true.
You can use help to show the **categories** too, generally called cogs. You can use help to show the **categories** too, generally called cogs,
Just do something like this (notice the capitalization): by doing the following (notice the capitalization):
.. code-block:: none .. code-block:: none
@ -122,7 +122,7 @@ To get the description of a subcommand, type this:
When using subcommands, you also need to specify the command group. When using subcommands, you also need to specify the command group.
As an example, ``cleanup`` has 6 subcommands. If you want As an example, ``cleanup`` has 6 subcommands. If you want
to use one, do it like this: ``[p]cleanup messages 10`` to use one of them, do: ``[p]cleanup messages 10``
.. _getting-started-cogs: .. _getting-started-cogs:
@ -217,7 +217,7 @@ Server owner
~~~~~~~~~~~~ ~~~~~~~~~~~~
The server owner can access all commands on his guild, except the global The server owner can access all commands on his guild, except the global
ones or those who can interact with system files (available for the ones or those that can interact with system files (available for the
bot owner). bot owner).
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
@ -237,12 +237,13 @@ Moderator
A moderator is a step above the average users. You can set multiple moderator A moderator is a step above the average users. You can set multiple moderator
roles with the ``[p]set addmodrole`` and ``[p]set removemodrole`` commands. roles with the ``[p]set addmodrole`` and ``[p]set removemodrole`` commands.
For example, in the mod cog (again), a mod will be able to mute, kick and ban; For example, in the filter cog, a mod will be able to use the various commands
but he won't be able to modify the cog settings with the ``[p]modset`` command. under ``[p]filter`` (such as adding and removing filtered words), but they will
not be able to modify the cog settings with the ``[p]filterset`` command.
.. tip:: .. tip::
If you don't like the default permission settings for some commands or If you don't like the default permission settings for some commands or
if want to restrict a cog or a command to a channel/member, you can use want to restrict a cog or a command to a channel/member, you can use
the permissions cog. the permissions cog.
.. _getting-started-hosting: .. _getting-started-hosting: