From 3107a0b5fda953361cc614c93b67e2f8f1249291 Mon Sep 17 00:00:00 2001 From: liv Date: Tue, 7 Dec 2021 02:42:22 -0500 Subject: [PATCH] fix(docs): broken links --- docs/content/command-list.md | 8 ++++---- docs/content/getting-started.md | 10 +++++----- docs/content/staff/compatibility.md | 2 +- docs/content/staff/permissions.md | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/content/command-list.md b/docs/content/command-list.md index d6b0e3f6..c4ec9816 100644 --- a/docs/content/command-list.md +++ b/docs/content/command-list.md @@ -118,7 +118,7 @@ Some arguments indicate the use of specific Discord features. These include: - `pk;log channel -clear` - Clears the currently set log channel. - `pk;log disable <#channel> [#channel...]` - Disables logging messages posted in the given channel(s) (useful for staff channels and such). - `pk;log enable <#channel> [#channel...]` - Re-enables logging messages posted in the given channel(s). -- `pk;logclean ` - Enables or disables [log cleanup](./staff/compatibility.md#log-cleanup). +- `pk;logclean ` - Enables or disables [log cleanup](/staff/compatibility/#log-cleanup). - `pk;blacklist add <#channel> [#channel...]` - Adds the given channel(s) to the proxy blacklist (proxying will be disabled here) - `pk;blacklist remove <#channel> [#channel...]` - Removes the given channel(s) from the proxy blacklist. @@ -128,21 +128,21 @@ Some arguments indicate the use of specific Discord features. These include: - `pk;invite` - Sends the bot invite link for PluralKit. - `pk;import` - Imports a data file from PluralKit or Tupperbox. - `pk;export` - Exports a data file containing your system information. -- `pk;debug permissions [server id]` - [Checks the given server's permission setup](./staff/permissions.md#permission-checker-command) to check if it's compatible with PluralKit. +- `pk;debug permissions [server id]` - [Checks the given server's permission setup](/staff/permissions/#permission-checker-command) to check if it's compatible with PluralKit. - `pk;debug proxying ` - Checks why your message has not been proxied. - `pk;edit [message link|reply] ` - Edits a proxied message. Without an explicit message target, will target the last message proxied by your system in the current channel. **Does not support message IDs!** - `pk;link ` - Links your system to a different account. - `pk;unlink [account]` - Unlinks an account from your system. ## API -*(for using the [PluralKit API](./api-documentation.md), useful for developers)* +*(for using the [PluralKit API](/api), useful for developers)* - `pk;token` - DMs you a token for using the PluralKit API. - `pk;token refresh` - Refreshes your API token and invalidates the old one. - `pk;s webhook [url]` - Shows or updates the [dispatch webhook](/api/dispatch) URL for your system. ## Help - `pk;help` - Displays a basic help message describing how to use the bot. -- `pk;help proxy` - Directs you to [this page](./user-guide.md#proxying). +- `pk;help proxy` - Directs you to [this page](/guide/#proxying). - `pk;system help` - Lists system-related commands. - `pk;member help` - Lists member-related commands. - `pk;switch help` - Lists switch-related commands. diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md index 855dfc8d..9aeee195 100644 --- a/docs/content/getting-started.md +++ b/docs/content/getting-started.md @@ -31,7 +31,7 @@ Second, **create a member** with the following command, inserting the member nam ::: tip You can include spaces, punctuation, or symbols in the member name. However, you'll need to write them `"in quotes"` every time you refer to the member elsewhere. -Instead, you can give your member a simple, easy to type name, then set the member's [display name](./user-guide.md#member-display-names) to a more complex version. That'll get displayed when proxying, and then you can keep the following commands simple. +Instead, you can give your member a simple, easy to type name, then set the member's [display name](/guide/#member-display-names) to a more complex version. That'll get displayed when proxying, and then you can keep the following commands simple. ::: ## Set some proxy tags @@ -68,9 +68,9 @@ Avatars have some restrictions: ## What's next? You could... -- [set up your member profile with descriptions, pronouns, etc](./user-guide.md#member-management) -- [log your switches](./user-guide.md#managing-switches) -- [configure privacy settings](./user-guide.md#privacy) +- [set up your member profile with descriptions, pronouns, etc](/guide/#member-management) +- [log your switches](/guide/#managing-switches) +- [configure privacy settings](/guide/#privacy) - or something else! -See the [User Guide](./user-guide.md) for a more complete reference of the bot's features. \ No newline at end of file +See the [User Guide](/guide) for a more complete reference of the bot's features. \ No newline at end of file diff --git a/docs/content/staff/compatibility.md b/docs/content/staff/compatibility.md index c53175d9..77997ac3 100644 --- a/docs/content/staff/compatibility.md +++ b/docs/content/staff/compatibility.md @@ -9,7 +9,7 @@ Some moderation bots have offical PluralKit support, and properly handle excludi - [**Catalogger**](https://catalogger.starshines.xyz/docs) - [**Crosslink**](https://crss.link) (Link detection / filtering) -If your server uses an in-house bot for logging, you can use [the API](../api-documentation.md) to implement support yourself. +If your server uses an in-house bot for logging, you can use [the API](/api) to implement support yourself. ## Log cleanup Another solution is for PluralKit to automatically delete log messages from other bots when they get posted. diff --git a/docs/content/staff/permissions.md b/docs/content/staff/permissions.md index 8d86de13..06137a9f 100644 --- a/docs/content/staff/permissions.md +++ b/docs/content/staff/permissions.md @@ -5,8 +5,8 @@ PluralKit requires some channel permissions in order to function properly: - Message proxying requires the **Manage Messages** and **Manage Webhooks** permissions in a channel. - Most commands require the **Embed Links**, **Attach Files** and **Add Reactions** permissions to function properly. - Commands with reaction menus also require **Manage Messages** to remove reactions after clicking. -- [Proxy logging](./logging.md) requires the **Send Messages** permission in the log channel. -- [Log cleanup](./compatibility.md#log-cleanup) requires the **Manage Messages** permission in the log channels. +- [Proxy logging](/staff/logging) requires the **Send Messages** permission in the log channel. +- [Log cleanup](/staff/compatibility/#log-cleanup) requires the **Manage Messages** permission in the log channels. Denying the **Send Messages** permission will *not* stop the bot from proxying, although it will prevent it from sending command responses. Denying the **Read Messages** permission will, as any other bot, prevent the bot from interacting in that channel at all.