mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
8e611b466e
* Getting started guide * Remove DigitalOcean referral link * Fix typos and mispells, thanks to @Flame442 * Remove cogs.red hyperlink until it is finished * Add towncrier entry * Admin guide * Add prolog.txt * Use substitutions for arguments * Some grammar fixes * Add prolog.txt This is not necessary for this PR but all of the other cog guides rely on this file. The cog guides are individual branches based on this one, which is why I'm adding this file right now. * Add changelog entry * Add serverlock * Apply suggestions from code review Co-Authored-By: Vexed <51716387+Vexed01@users.noreply.github.com> * Suggestions from vexed * Update to new admin commands * Delete 1734.docs.2.rst * Apply the changes requested by reviewers Plus add a small tuto on how to make a bot private * Fix arguments inconsistency * Remove ctx from argments * Update docs/cog_guides/admin.rst Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com> * Quotes aaaaaa Co-authored-by: Toby Harradine <Tobotimus@users.noreply.github.com> Co-authored-by: Vexed <51716387+Vexed01@users.noreply.github.com> Co-authored-by: Flame442 <34169552+Flame442@users.noreply.github.com>
51 lines
2.0 KiB
Plaintext
51 lines
2.0 KiB
Plaintext
.. This file will be run at the beginning of all files.
|
|
You can add the subsitutions you need.
|
|
|
|
.. this is a .txt so sphinx doesn't error because it's
|
|
missing in the index
|
|
|
|
|
|
.. These are the comments for permissions locks
|
|
|
|
.. |owner-lock| replace:: This command is locked to the
|
|
:ref:`bot owner <getting-started-permissions>`.
|
|
|
|
.. |guildowner-lock| replace:: This command is locked to the
|
|
:ref:`server owner <getting-started-permissions>`.
|
|
|
|
.. |admin-lock| replace:: This command is locked to the
|
|
:ref:`admin role <getting-started-permissions>`.
|
|
|
|
.. |mod-lock| replace:: This command is locked to the
|
|
:ref:`mod role <getting-started-permissions>`.
|
|
|
|
|
|
.. This is for describing how a format should be formatted
|
|
|
|
.. |role-input| replace:: Please give **the exact role name or ID**, or it won't be detected.
|
|
|
|
.. |role-input-quotes| replace:: Please give **the exact role name or ID**, or it won't be detected.
|
|
If the role name has spaces, provide it enclosed in quotes like this: ``"my role with spaces"``
|
|
|
|
.. |member-input| replace:: You can either mention the member, provide its ID, its exact name with
|
|
the tag or not, or its nickname.
|
|
|
|
.. |member-input-quotes| replace:: You can either mention the member, provide its ID, its exact
|
|
name with the tag or not, or its nickname enclosed in quotes if there are spaces.
|
|
|
|
.. |user-input| replace:: You can either provide the member's ID or its exact name with the tag or
|
|
not.
|
|
|
|
.. |user-input-quotes| replace:: You can either provide the member's ID or its exact name with the
|
|
tag or not, enclosed in quotes if there are spaces.
|
|
|
|
.. |channel-input| replace:: You can either mention the channel, provide its exact name or its ID.
|
|
|
|
.. |vc-input| replace:: You can either provide the voice channel's ID or its exact name.
|
|
|
|
.. |vc-input-quotes| replace:: You can either provide the voice channel's ID or its exact name,
|
|
enclosed in quotes if there are spaces.
|
|
|
|
.. |color-input| replace:: You can either provide the hexadecimal code of the color, or one of the
|
|
colors listed here: :class:`discord.Color`.
|