Skip to content

Commit 8678013

Browse files
committed
all: callout titles, text reflow, remove dupe / confusing text
Add meaningful titles to all callouts of the format `Type: Title`. If no appropriate title can be found, especially for single sentences, I elected to remove the callout entirely (but keep the sentence). Reflow some text that grossly exceeded 120 columns and get rid of some GitBook generator artifacts like `&#x20;`- and `\`-spam. Remove some confusing / outdated / now incorrect text, primarily the "Legend" on the functions reference. I have made a mental note to rework the introduction on Syntax and Data as well as Functions. Signed-off-by: Luca Zeuch <[email protected]>
1 parent 243514a commit 8678013

27 files changed

+249
-307
lines changed

content/docs/core/command-settings.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ prefix was instead `?`, one would use `?remindme ...`, and so on.
2626

2727
Slash commands are always triggered using the `/` character and hence do not depend on the prefix configured here.
2828

29-
{{< callout context="tip" title="Tip" icon="outline/rocket" >}}
29+
{{< callout context="tip" title="Tip: Mention as a Command Prefix" icon="outline/rocket" >}}
3030

3131
In addition to the command prefix, you can trigger YAGPDB commands by pinging the bot at the start of your message. This
3232
is helpful if you forget your prefix, as sending `@YAGPDB.xyz prefix` will recall it.
3333

3434
{{< /callout >}}
3535

36-
{{< callout context="caution" title="Flags and Switches" icon="outline/alert-triangle" >}}
36+
{{< callout context="caution" title="Caution: Flags and Switches" icon="outline/alert-triangle" >}}
3737

3838
Flags and switches are **_not_** affected by your prefix setting.
3939

@@ -52,21 +52,18 @@ where the `raw` switch is still spelled `-raw`, not `?raw`.
5252
Command overrides are considered in the following order, with settings applied at later steps overwriting earlier ones:
5353

5454
1. If the _All commands enabled_ setting is not checked, all commands are initially disabled (otherwise enabled.)
55-
2. General restrictions configured in _Global Settings_ are then applied, base restrictions before command-specific restrictions.
55+
2. General restrictions configured in _Global Settings_ are then applied, base restrictions before command-specific
56+
restrictions.
5657
3. Channel-specific restrictions (_Override #1_, _Override #2_, ...) are applied analogously.
5758

58-
The order above trickles down from least specific to most specific, prioritizing the most specific setting -- an analogy
59+
The order above trickles down from least specific to most specific, prioritizing the most specific setting---an analogy
5960
for developers would be CSS's cascading rules.
6061

61-
{{< callout context="note" title="Example" icon="outline/info-circle" >}}
62-
6362
Though perhaps confusing at first, the priority order above is designed to make common configurations trivial. For
64-
instance, to disable all but a specific command -- say the `remindme` command -- one can simply disable the _All
63+
instance, to disable all but a specific command---say the `remindme` command---one can simply disable the _All
6564
commands enabled_ option and then create a command override that enables only `remindme`. This is possible as command
6665
overrides are applied after the _All commands enabled_ setting.
6766

68-
{{< /callout >}}
69-
7067
## Options
7168

7269
### Common Options
@@ -80,13 +77,11 @@ Clicking on either of these options (**3**,**4**) opens a drop-down menu with al
8077
Select as many as you wish. YAGPDB will then either require all members to have any of these roles in order to run
8178
commands, or completely ignore members with any of the ignored roles, server admins and owners included.
8279

83-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
80+
{{< callout context="note" title="Note: Priority of Ignored vs. Required Roles" icon="outline/info-circle" >}}
8481

8582
YAGPDB was raised well and honors a "no" when told "no". In other words, ignored roles take precedence over required
8683
roles.
8784

88-
This is a relatively common trip-hazard, so take great care when you set up both required and ignored roles.
89-
9085
{{< /callout >}}
9186

9287
#### Autodelete Trigger / Response Interval
@@ -101,12 +96,8 @@ If 10 seconds are not enough, or too long, feel free to adjust as you see fit; t
10196
These options are only available for channel overrides (**8**). To add a new one, head to the _New channel override_
10297
tab on the command settings page.
10398

104-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
105-
10699
You must select at least one channel or category; otherwise, the settings of the override will not be applied.
107100

108-
{{< /callout >}}
109-
110101
#### Channels
111102

112103
With this setting, you can select individual channels to apply the override to. Select as many as you wish.

content/docs/custom-commands/commands.md

Lines changed: 9 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Edit this to change the output of the custom command {{.CCID}}!
3030

3131
Each custom command is assigned a unique incrementing ID, which cannot be modified after creation.
3232

33-
{{< callout context="tip" title="Troubleshooting" icon="outline/rocket" >}}
33+
{{< callout context="tip" title="Tip: Troubleshooting" icon="outline/rocket" >}}
3434

3535
![Empty CC Discord Messages](empty_cc_1.png)
3636

@@ -79,21 +79,13 @@ Selecting a group allows you to edit it. Changes must be saved (**11**) to take
7979
Using role/channel restrictions, it is possible to set conditions on which users can trigger a custom command.
8080

8181
Specifically, whitelisted roles or channels are required to run the command, whereas blacklisted roles or channels
82-
cannot use the command at all.
82+
cannot use the command at all. These role restrictions are unrelated to member permissions. Having `Administrator`
83+
permissions will not override these restrictions.
8384

84-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
85+
{{< callout context="note" title="Note: Priority of Ignored vs. Required Roles" icon="outline/info-circle" >}}
8586

8687
YAGPDB was raised well and honors a "no" when told "no". In other words, blacklists take precedence over whitelists.
8788

88-
This is a relatively common trip-hazard, so take great care when you set up both whitelists and blacklists.
89-
90-
{{< /callout >}}
91-
92-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
93-
94-
Role restrictions are unrelated to member permissions. Having `Administrator` permissions will not override these
95-
restrictions.
96-
9789
{{< /callout >}}
9890

9991
## Editing a Custom Command
@@ -125,7 +117,7 @@ commands like `customcommands` accept a CC ID as an argument.
125117

126118
Within a command response, the ID may be retrieved using the `{{ .CCID }}` template.
127119

128-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
120+
{{< callout context="danger" title="Danger: Deleting is Irreversible" icon="outline/alert-octagon" >}}
129121

130122
Deleting a custom command does not allow its ID to be reassigned. If you delete a CC, its ID is lost forever.
131123

@@ -187,7 +179,7 @@ Reactions to a message will trigger the command.
187179

188180
Can specify **Added Only**, **Removed Only**, or **Both** to restrict which types of Reactions will trigger the command.
189181

190-
{{< callout context="tip" title="Filtering Emojis" icon="outline/rocket" >}}
182+
{{< callout context="tip" title="Tip: Filtering Emojis" icon="outline/rocket" >}}
191183

192184
You cannot specify which emojis the command will trigger on. If you'd like to limit which emojis run the code, you will
193185
need to write that code yourself in the response.
@@ -232,12 +224,8 @@ When editing an interval command, a **Run Now** button appears at the bottom of
232224
long as the command is not disabled and a channel is selected. Running an interval command using this button reschedules
233225
all subsequent runs based off the current time.
234226

235-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
236-
237227
You must specify a channel to run interval commands in even if the command doesn't output a message.
238228

239-
{{< /callout >}}
240-
241229
##### Component
242230

243231
[In-depth Interactions Guide](/docs/reference/custom-interactions)
@@ -282,13 +270,6 @@ getting data from users, sending messages to other channels, and more. Visit the
282270

283271
{{< link-card href="/docs/reference/templates/syntax-and-data" description="Templates" target="_blank" >}}
284272

285-
{{< callout context="tip" title="Keeping your code safe" icon="outline/rocket" >}}
286-
287-
It is recommended to save local copies of your custom commands. There is no way to recover deleted or overwritten CCs.
288-
Use an editor like **Vim**, **VS Code**, or **Notepad++** for the best coding experience.
289-
290-
{{< /callout >}}
291-
292273
### Custom Command Group
293274

294275
Dropdown selection (**9**) to change which command group the command is in. Select `None` to ungroup the command.
@@ -319,7 +300,7 @@ not send a response. It also increases if the command is run via `execCC`.
319300

320301
The run count will not increase if the user who ran the command did not pass the restrictions.
321302

322-
{{< callout context="tip" title="Troubleshooting" icon="outline/rocket" >}}
303+
{{< callout context="tip" title="Tip: Troubleshooting" icon="outline/rocket" >}}
323304

324305
If your command fails to run, check the run count. If the run count increases when you attempt to run the command, the
325306
issue is with your code. Otherwise, the issue may be with YAGPDB's permissions in your server, or improperly configured
@@ -359,15 +340,15 @@ A custom command **will not save** if there is an error in your input. Examples
359340

360341
If you save a command with an interval trigger which has never been run, it will run immediately upon saving.
361342

362-
{{< callout context="tip" title="Keeping your code safe" icon="outline/rocket" >}}
343+
{{< callout context="tip" title="Tip: Keeping Your Code Safe" icon="outline/rocket" >}}
363344

364345
It is recommended to code your custom command using a local editor on your device. You will not be able to save your
365346
code on the dashboard if there are syntax errors in your code. Use an editor like **Vim**, **VS Code**, or **Notepad++**
366347
for the best coding experience.
367348

368349
{{< /callout >}}
369350

370-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
351+
{{< callout context="danger" title="Danger: Remember to Save" icon="outline/alert-octagon" >}}
371352

372353
Custom commands do not autosave.
373354

content/docs/fun/soundboard.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,39 +19,35 @@ Choose to require users to have a role in order to play this sound.
1919

2020
### Upload file
2121

22-
{{< callout context="tip" title="Tip" icon="outline/rocket" >}}
22+
{{< callout context="note" title="Note: Choose Either URL or File Upload" icon="outline/info-circle" >}}
2323

2424
Do **not** fill in the URL if you are going uploaded from local files, and vice versa.
2525

2626
{{< /callout >}}
2727

28+
2829
You have two options to upload sounds:
2930

3031
- Upload with local files
3132
- Specify a URL
3233

3334
#### Upload with local files
3435

35-
Click on _Choose file_ and \_\_ select an audio file to upload. All types of sound files, including videos with sound
36-
tracks, are supported.
36+
Click on _Choose file_ and select an audio file to upload. All types of sound files, including videos with soundtracks,
37+
are supported.
3738

3839
#### Specify a URL
3940

40-
You can also specify a sound URL instead of uploading one.&#x20;
41-
42-
{{< callout context="tip" title="Tip" icon="outline/rocket" >}}
41+
You can also specify a sound URL instead of uploading one.
4342

44-
This has to be the direct link to the media file, and not a YouTube link. A direct link should end with`.mp3`(or other
45-
relevant audio/video type), such as
46-
[http://soundboard.panictank.net/AIRHORN.mp3](http://soundboard.panictank.net/AIRHORN.mp3).&#x20;
47-
48-
{{< /callout >}}
43+
This has to be the direct link to the media file, and not, for example, a YouTube Video link. A direct link should end
44+
with `.mp3` (or other relevant audio/video type), such as <https://soundboard.panictank.net/AIRHORN.mp3>.
4945

5046
### Finish
5147

5248
Click on _Upload/Download_ after you are done with the previous steps. You should see a _Success_ notification when the
53-
upload is completed. Check the status of the sound under _Existing sounds_. \__ Wait for several minutes, and press
54-
\_Save_ again if the status does not show _Ready_.
49+
upload is completed. Check the status of the sound under _Existing sounds_. Wait for several minutes, and press
50+
_Save_ again if the status does not show _Ready_.
5551

5652
![An example of a successfully uploaded sound](example_soundboard.png)
5753

content/docs/moderation/advanced-automoderator/conditions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ By extension, these conditions are also available as ruleset scoped conditions.
2121
All conditions have to be met in order for a rule to execute — that is, the conditions are combined according to the
2222
logical AND operator.
2323

24-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
24+
{{< callout context="danger" title="Danger: Mutual Exclusivity" icon="outline/alert-octagon" >}}
2525

2626
Ensure that the conditions you set are not in conflict or mutually exclusive, as this will cause your rule to never
2727
trigger.

content/docs/moderation/logging.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ limited number of deleted messages.
99

1010
<!--more-->
1111

12-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
12+
{{< callout context="note" title="Note: Not a Logging Bot" icon="outline/info-circle" >}}
1313

1414
YAGPDB IS NOT A LOGGING BOT.
1515

@@ -24,7 +24,7 @@ The log is accessible on YAGPDB's website for later viewing. It saves message ti
2424
User ID, and the message itself. If a message contains an attachment, the attachment URL is logged. If a message
2525
contains an embed, it is serialized and saved in JSON format.
2626

27-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
27+
{{< callout context="danger" title="Danger: Maximum Log Retention" icon="outline/alert-octagon" >}}
2828

2929
Message logs on the official YAGPDB instance will be automatically deleted after 30 days of their creation.
3030

content/docs/moderation/moderation-tools.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ mute tab on the control panel.
185185

186186
[Unmute Command Syntax](/docs/core/all-commands#unmute)
187187

188-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
188+
{{< callout context="danger" title="Danger: Discord Permission Precedence" icon="outline/alert-octagon" >}}
189189

190190
Within a server channel's permission overrides, allowing a permission to a specific role or user supersedes disallowing
191191
a permission to a specific role. This means if you grant Role X the permission to send messages in a channel and
@@ -199,7 +199,7 @@ when configuring other roles' permission overrides.
199199

200200
{{< /callout >}}
201201

202-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
202+
{{< callout context="note" title="Note: Unmute Author After Duration Expired" icon="outline/info-circle" >}}
203203

204204
If you set a duration for the mute, the bot will unmute the user after the specified duration. When this occurs, it
205205
appears as an unmute action taken by YAGPDB in your mod log, regardless of which moderator initially muted the user.
@@ -237,7 +237,7 @@ field in the ban tab on the control panel which enables automatic deletion when
237237

238238
[Unban Command Syntax](/docs/core/all-commands#unban)
239239

240-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
240+
{{< callout context="note" title="Note: Unban Author After Duration Expired" icon="outline/info-circle" >}}
241241

242242
If you set a duration for the ban, the bot will unban the user after the specified duration. When this occurs, it
243243
appears as an unban action taken by YAGPDB in your mod log, regardless of which moderator initially banned the user.
@@ -276,7 +276,7 @@ You may optionally send warnings to the mod log, this is enabled in the warnings
276276
[TopWarnings Command Syntax](/docs/core/all-commands#topwarnings) - Shows ranked list of warnings on the server, allowing you to turn
277277
misbehavior into a fun minigame for your server members.
278278

279-
{{< callout context="tip" title="Taking Action on Warn Count" icon="outline/rocket" >}}
279+
{{< callout context="tip" title="Tip: Taking Action on Warn Count" icon="outline/rocket" >}}
280280

281281
Some users prescribe an "x warnings => mute/kick/ban" rule for their servers. To have YAGPDB automatically take action
282282
based on warning count, you can take advantage of the template scripting within the warning DM.

content/docs/moderation/verification.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This is accomplished by sending new members a customizable DM (which employs [te
1616
containing a unique link to verify, tied to their User ID. This link takes them to a customizable verification page with
1717
a CAPTCHA challenge. Once completed, the User ID is assigned the verified role.
1818

19-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
19+
{{< callout context="note" title="Note: Verified Role" icon="outline/info-circle" >}}
2020

2121
You must assign a "Verified Role" on the Verification page in the control panel. The plugin will not function if no role
2222
is selected.
@@ -46,7 +46,7 @@ You can customize both messages in the Verification page on the control panel.
4646
Verification scripts provide `.Link` as additional dot context data. This is the unique verification link the user must
4747
visit to verify.
4848

49-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
49+
{{< callout context="danger" title="Danger: DMs may not be Received" icon="outline/alert-octagon" >}}
5050

5151
If a user has disabled DMs from server members by default, upon joining your server YAGPDB will fail to send a
5252
verification DM to the user. It is recommended that you inform your new members about this possibility and how to fix it
@@ -74,7 +74,7 @@ Logged events are:
7474

7575
## Alt Detection
7676

77-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
77+
{{< callout context="note" title="Note: Disabled on Official Instance" icon="outline/info-circle" >}}
7878

7979
Alt Detection is currently disabled on the official instance of YAGPDB hosted by Botlabs. These features will not
8080
function on the official bot.

content/docs/notifications/general.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Write a message that you want the bot to send to the user via DM whenever someon
3030
Choose what channel you want the bot to announce the topic change from a specific channel or the channel that the topic
3131
was changed in.
3232

33-
{{< callout context="tip" title="Tip" icon="outline/rocket" >}}
33+
{{< callout context="tip" title="Tip: Custom Command Syntax" icon="outline/rocket" >}}
3434

3535
Custom command templates are supported for usage in all the notification feeds provided.
3636

content/docs/notifications/reddit.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,6 @@ Get notifications from your favorite subreddits directly in your Discord server.
88

99
<!--more-->
1010

11-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
12-
13-
Fast Reddit feeds to the **top 10 subreddits** are disabled, due to being too spammy for YAGPDB's current system.
14-
15-
{{< /callout >}}
16-
1711
## Reddit Feed
1812

1913
![Small showcase of the Reddit feeds interface.](./reddit.png)

content/docs/notifications/streaming.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ Let everyone know that someone is currently streaming.
99

1010
### Streaming Feed
1111

12-
{{< callout context="note" title="Note" icon="outline/info-circle" >}}
12+
{{< callout context="note" title="Note: Announcements may not Post" icon="outline/info-circle" >}}
1313

1414
There are currently some issues with the streaming announcement, and it may not always give the announcement. It will
1515
however, always assign the streamer role.
1616

1717
{{< /callout >}}
1818

19-
{{< callout context="danger" title="Danger" icon="outline/alert-octagon" >}}
19+
{{< callout context="danger" title="Danger: Automatic Role Removal" icon="outline/alert-octagon" >}}
2020

2121
The streaming role will be **automatically removed** from a member that is not streaming if it is given manually, so be
2222
careful! If YAGPDB is removing member's roles without apparent reason, this may well be the cause.

0 commit comments

Comments
 (0)