Skip to content

Commit 73abe60

Browse files
committed
all: reflow to semantic line feeds
Signed-off-by: Luca Zeuch <[email protected]>
1 parent 02c9ad8 commit 73abe60

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1931
-2202
lines changed

.editorconfig

Lines changed: 0 additions & 12 deletions
This file was deleted.

.github/workflows/lint.yml

Lines changed: 0 additions & 20 deletions
This file was deleted.

README.md

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,35 @@
22

33
Experimental / proof of concept page to replace the current documentation which is built with GitBook.
44

5-
This documentation is built with [Hugo](https://gohugo.io) in conjunction with the [Doks theme](https://getdoks.org/) as
6-
an experiment to see if it is a viable alternative.
5+
This documentation is built with [Hugo](https://gohugo.io) in conjunction with the [Doks theme](https://getdoks.org/) as an experiment to see if it is a viable alternative.
76

87
## Contributing / Building
98

10-
Install [Node.js](https://nodejs.org/en), clone this repository, install the dependencies with `npm install`, and run
11-
`npm run dev` to start a local server. The server will automatically rebuild the page when you make changes.
9+
Install [Node.js](https://nodejs.org/en), clone this repository, install the dependencies with `npm install`, and run `npm run dev` to start a local server.
10+
The server will automatically rebuild the page when you make changes.
1211

13-
To build the page in release mode, use `HUGO_BASEURL=... npm run build`, then serve the generated `public/` directory
14-
with your webserver of choice.
12+
To build the page in release mode, use `HUGO_BASEURL=... npm run build`, then serve the generated `public/` directory with your webserver of choice.
1513

1614
For more information, please view our [Contributing Guidelines](.github/CONTRIBUTING.md).
1715

1816
### Editor Setup
1917

20-
As this project uses the [EditorConfig](https://editorconfig.org/) standard, you will have to make sure that your
21-
editor supports it. Most modern editors do, but if you are unsure, check the EditorConfig page.
18+
As this project uses the [EditorConfig](https://editorconfig.org/) standard, you will have to make sure that your editor supports it.
19+
Most modern editors do, but if you are unsure, check the EditorConfig page.
2220

2321
### Authoring Content
2422

25-
Pages are written in Markdown with additional shortcodes provided by the Doks theme; refer to [its
26-
documentation](<(https://getdoks.org/docs/start-here/getting-started/)>) for a complete list of features.
23+
Pages are written in Markdown with additional shortcodes provided by the Doks theme; refer to [its documentation](<(https://getdoks.org/docs/start-here/getting-started/)>) for a complete list of features.
2724

28-
If you are editing pages related to custom commands, note that codeblocks support a custom `yag` language for accurate
29-
syntax highlighting—do not use `go`. However, this feature is only enabled in production builds for performance, so
30-
`npm run dev` will _not_ highlight `yag` codeblocks. Use `npm run build` followed by `npm run preview` instead if you
31-
need to verify that code is highlighted correctly.
25+
If you are editing pages related to custom commands, note that codeblocks support a custom `yag` language for accurate syntax highlighting—do not use `go`.
26+
However, this feature is only enabled in production builds for performance, so `npm run dev` will _not_ highlight `yag` codeblocks.
27+
Use `npm run build` followed by `npm run preview` instead if you need to verify that code is highlighted correctly.
3228

3329
> [!TIP]
3430
> If you use VSCode, this project provides custom workspace snippets to insert callouts, which you can activate in
3531
> Markdown files by typing <kbd>Ctrl</kbd> + <kbd>Space</kbd> followed by `note`, `tip`, `warning`, or `danger`.
3632
3733
## License
3834

39-
This documentation's text is distributed under the terms of the Creative Commons Attribution ShareAlike 4.0 license
40-
(SPDX-indentifer `CC-BY-SA`). Please view the [LICENSE](LICENSE) file for more information.
35+
This documentation's text is distributed under the terms of the Creative Commons Attribution ShareAlike 4.0 license (SPDX-indentifer `CC-BY-SA`).
36+
Please view the [LICENSE](LICENSE) file for more information.

config/.markdownlint.yaml

Lines changed: 0 additions & 96 deletions
This file was deleted.

content/docs/core/command-settings.md

Lines changed: 41 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -8,28 +8,33 @@ Fine-grained control over all of YAGPDB's inbuild commands.
88

99
## Overview
1010

11-
Command overrides allow you to restrict access to YAGPDB's inbuilt commands and optionally configure intervals after
12-
which the command trigger and response will be autodeleted. The key features of the page are as follows:
13-
14-
![Overview of the Command Settings page.](command_settings_overview.png)
11+
Command overrides allow you to restrict access to YAGPDB's inbuilt commands and optionally configure intervals after which the command trigger and response will be autodeleted.
12+
The key features of the page are shown below.
1513

1614
<center>
1715

18-
**1** Command prefix, default `-` **2** _All commands enabled_ setting **3** Required roles **4** Ignored roles
19-
**5** Autodelete trigger interval **6** Autodelete response interval **7** Command overrides **8** Channel overrides tabs
16+
**1** Command prefix.
17+
**2** All commands enabled setting.
18+
**3** Required roles.
19+
**4** Ignored roles.
20+
**5** Autodelete trigger interval.
21+
**6** Autodelete response interval.
22+
**7** Command overrides.
23+
**8** Channel overrides tabs.
2024

2125
</center>
2226

23-
The prefix (**1**) is a short sequence of characters that trigger YAGPDB commands. By default, the prefix is `-`. Thus,
24-
for instance, the `remindme` command is invoked by prefixing the command name with a hyphen: `-remindme ...`. If the
25-
prefix was instead `?`, one would use `?remindme ...`, and so on.
27+
The prefix (**1**) is a short sequence of characters that trigger YAGPDB commands.
28+
By default, the prefix is `-`.
29+
Thus, for instance, the `remindme` command is invoked by prefixing the command name with a hyphen: `-remindme ...`.
30+
If the prefix was instead `?`, one would use `?remindme ...`, and so on.
2631

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

2934
{{< callout context="tip" title="Tip: Mention as a Command Prefix" icon="outline/rocket" >}}
3035

31-
In addition to the command prefix, you can trigger YAGPDB commands by pinging the bot at the start of your message. This
32-
is helpful if you forget your prefix, as sending `@YAGPDB.xyz prefix` will recall it.
36+
In addition to the command prefix, you can trigger YAGPDB commands by pinging the bot at the start of your message.
37+
This is helpful if you forget your prefix, as sending `@YAGPDB.xyz prefix` will recall it.
3338

3439
{{< /callout >}}
3540

@@ -56,56 +61,54 @@ Command overrides are considered in the following order, with settings applied a
5661
restrictions.
5762
3. Channel-specific restrictions (_Override #1_, _Override #2_, ...) are applied analogously.
5863

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

62-
Though perhaps confusing at first, the priority order above is designed to make common configurations trivial. For
63-
instance, to disable all but a specific command---say the `remindme` command---one can simply disable the _All
64-
commands enabled_ option and then create a command override that enables only `remindme`. This is possible as command
65-
overrides are applied after the _All commands enabled_ setting.
66+
Though perhaps confusing at first, the priority order above is designed to make common configurations trivial.
67+
For instance, to disable all but a specific command---say the `remindme` command---one can simply disable the _All commands enabled_ option and then create a command override that enables only `remindme`.
68+
This is possible as command overrides are applied after the _All commands enabled_ setting.
6669

6770
## Options
6871

6972
### Common Options
7073

71-
These options are common across all three sub-settings: global settings, channel overrides, and individual command
72-
overrides.
74+
These options are common across all three sub-settings: global settings, channel overrides, and individual command overrides.
7375

7476
#### Required and Ignored Roles
7577

76-
Clicking on either of these options (**3**,**4**) opens a drop-down menu with all the roles present on your server.
77-
Select as many as you wish. YAGPDB will then either require all members to have any of these roles in order to run
78-
commands, or completely ignore members with any of the ignored roles, server admins and owners included.
78+
Clicking on either of these options (**3**, **4**) opens a drop-down menu with all the roles present on your server.
79+
Select as many as you wish.
80+
YAGPDB will then either require all members to have any of these roles in order to run commands, or completely ignore members with any of the ignored roles, server admins and owners included.
7981

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

82-
YAGPDB was raised well and honors a "no" when told "no". In other words, ignored roles take precedence over required
83-
roles.
84+
YAGPDB was raised well and honors a "no" when told "no".
85+
In other words, ignored roles take precedence over required roles.
8486

8587
{{< /callout >}}
8688

8789
#### Autodelete Trigger / Response Interval
8890

89-
This setting makes YAGPDB automatically delete the triggering message and/or its response after the configured duration
90-
has passed. To activate it, make sure to click the checkbox next to the respective input field (**5**,**6**).
91+
This setting makes YAGPDB automatically delete the triggering message and/or its response after the configured duration has passed.
92+
To activate it, make sure to click the checkbox next to the respective input field (**5**, **6**).
9193

9294
If 10 seconds are not enough, or too long, feel free to adjust as you see fit; the intervals need not be equal.
9395

9496
#### Slash command response always ephemeral
9597

96-
Toggling this setting on will make YAGPDB always respond to slash commands with an ephemeral message. This means that
97-
only the user who triggered the command will be able to see the response.
98+
Toggling this setting on will make YAGPDB always respond to slash commands with an ephemeral message.
99+
This means that only the user who triggered the command will be able to see the response.
98100

99101
### Channel Override Options
100102

101-
These options are only available for channel overrides (**8**). To add a new one, head to the _New channel override_
102-
tab on the command settings page.
103+
These options are only available for channel overrides (**8**).
104+
To add a new one, head to the _New channel override_ tab on the command settings page.
103105

104106
You must select at least one channel or category; otherwise, the settings of the override will not be applied.
105107

106108
#### Channels
107109

108-
With this setting, you can select individual channels to apply the override to. Select as many as you wish.
110+
With this setting, you can select individual channels to apply the override to.
111+
Select as many as you wish.
109112

110113
You find this setting in the top-left corner of any channel override.
111114

@@ -117,17 +120,16 @@ You find this setting in the top-right corner of any channel override, adjacent
117120

118121
### Command Override Options
119122

120-
These options are only available for individual command overrides (**7**). To add a new one, go to either your
121-
global settings or any channel override and click on _New command override_.
123+
These options are only available for individual command overrides (**7**).
124+
To add a new one, go to either your global settings or any channel override and click on _New command override_.
122125

123126
#### Commands
124127

125-
This setting allows you to select specific commands to apply the command override to. Select as many as you wish to
126-
apply an override to. You cannot have two (or more) overrides for the same command in the same tab, i.e. global settings
127-
or a specific channel override.
128+
This setting allows you to select specific commands to apply the command override to.
129+
Select as many as you wish to apply an override to.
130+
You cannot have two (or more) overrides for the same command in the same tab, i.e. global settings or a specific channel override.
128131

129132
#### Enable Specified Commands
130133

131-
Toggling this option simply tells YAGPDB whether the commands you selected are enabled or disabled. This allows you to
132-
disable some specific commands, which may be useful if -- for example -- you have created a custom command that
133-
completely replaces an inbuilt one.
134+
Toggling this option simply tells YAGPDB whether the commands you selected are enabled or disabled.
135+
This allows you to disable some specific commands, which may be useful if -- for example -- you have created a custom command that completely replaces an inbuilt one.

content/docs/core/control-panel-access.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,31 @@ weight = 210
44
description = "Select who can view or edit your control panel."
55
+++
66

7-
This page is relatively simple, yet very powerful. An overview of the settings follows.
7+
This page is relatively simple, yet very powerful.
8+
An overview of the settings follows.
89

910
![Overview of the control panel access configuration page.](control_panel_access.png)
1011

1112
### Read Access
1213

1314
#### Allow people with the following roles
1415

15-
The very top option is to allow people with certain roles read access to the control panel. Simply open the drop-down
16-
select menu and select the roles you wish to grant read access.
16+
The very top option is to allow people with certain roles read access to the control panel.
17+
Simply open the drop-down select menu and select the roles you wish to grant read access.
1718

1819
#### Allow all members read access
1920

20-
This switch is fairly straight forward, when enabled any and all members of your server are granted read access. For
21-
reference, this is enabled on the support server, but it may be a good idea to keep it disabled.
21+
This switch is fairly straight forward, when enabled any and all members of your server are granted read access.
22+
For reference, this is enabled on the support server, but it may be a good idea to keep it disabled.
2223

2324
#### Allow users not part of your server read access
2425

25-
Taking the above one step further, this toggle lets any and all users, even not logged in ones, to view your control
26-
panel. In general, it is a very good idea to have this disabled, unless you have good reasons not to. For the record,
27-
this option is enabled on the support server's control panel.
26+
Taking the above one step further, this toggle lets any and all users, even not logged in ones, to view your control panel.
27+
In general, it is a very good idea to have this disabled, unless you have good reasons not to.
28+
For the record, this option is enabled on the support server's control panel.
2829

2930
### Write Access
3031

31-
Quite simple, but moderately dangerous. Anyone with these roles can edit anything on your control panel, so do handle
32-
this with care. To make things easier to configure, members with **Manage Server** permissions can always edit the
33-
control panel.
32+
Quite simple, but moderately dangerous.
33+
Anyone with these roles can edit anything on your control panel, so do handle this with care.
34+
To make things easier to configure, members with **Manage Server** permissions can always edit the control panel.

content/docs/core/control-panel-logs.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ weight = 220
44
description = "View a list of recent changes to your YAGPDB configuration."
55
+++
66

7-
This page is the analogue of the audit log built in to Discord for YAGPDB settings and summarizes recent edits on the
8-
control panel, listing the time, action, and responsible user for each. It is useful to audit who may be responsible if
9-
things go haywire, but other than that this page is unlikely to be of use.
7+
This page is the analogue of the audit log built in to Discord for YAGPDB settings and summarizes recent edits on the control panel, listing the time, action, and responsible user for each.
8+
It is useful to audit who may be responsible if things go haywire, but other than that this page is unlikely to be of use.
109

11-
Please do not be confused if you see changes from the user `destroy_0001` (ID `598900258579283976`), as that is the bot
12-
developer and he may at times need to change certain settings to ensure proper operation.
10+
Please do not be confused if you see changes from the user `destroy_0001` (ID `598900258579283976`), as that is the bot developer and he may at times need to change certain settings to ensure proper operation.
1311

1412
![Screenshot of some example control panel logs.](control_panel_logs.png)

0 commit comments

Comments
 (0)