Update documentation (#332)

Co-authored-by: Petal Rose <habonimkef@gmail.com>

.gitignore

@@ -4,8 +4,10 @@ obj/
 
 # IDE files
 .idea/
+.run/
 .vscode/
 tags/
+.DS_Store
 
 # Dependencies
 node_modules/

docs/content/command-list.md

@@ -9,6 +9,27 @@ nav_order: 3
 # How to read this
 Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank. Square brackets mean this is optional. Don't include the actual brackets.
 
+## Special arguments
+Some arguments indicate the use of specific Discord features. These include:
+
+- `@mention`: insert a Discord mention (or "ping")
+
+::: details Mention example
+![Mention example](./assets/mention_arg.png)
+:::
+
+- `reply`: reply to a previous message
+
+::: details Message reply example
+![Message reply example](./assets/reply_arg.png)
+:::
+
+- `upload`: upload a file
+
+::: details Upload example
+![Upload example](./assets/upload_arg.png)
+:::
+
 # Commands
 ## System commands
 *Optionally replace `[system]` with a @mention, Discord account ID, or 5-character ID. For most commands, adding `-clear` will clear/delete the field.*
@@ -16,7 +37,7 @@ Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank.
 - `pk;system new [name]` - Creates a new system registered to your account.
 - `pk;system rename [new name]` - Changes the name of your system.
 - `pk;system description [description]` - Changes the description of your system.
-- `pk;system avatar [avatar url]` - Changes the avatar of your system.
+- `pk;system avatar [avatar url|@mention|upload]` - Changes the avatar of your system.
 - `pk;system privacy` - Displays your system's current privacy settings.
 - `pk;system privacy <subject> <public|private>` - Changes your systems privacy settings.
 - `pk;system tag [tag]` - Changes the system tag of your system.
@@ -42,8 +63,8 @@ Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank.
 - `pk;member <name> displayname <new display name>` - Changes the display name of a member.
 - `pk;member <name> servername <new server name>` - Changes the display name of a member, only in the current server.
 - `pk;member <name> description [description]` - Changes the description of a member.
-- `pk;member <name> avatar <avatar url|@mention>` - Changes the avatar of a member.
+- `pk;member <name> avatar [avatar url|@mention|upload]` - Changes the avatar of a member.
-- `pk;member <name> serveravatar <avatar url|@mention>` - Changes the avatar of a member in a specific server.
+- `pk;member <name> serveravatar [avatar url|@mention|upload]` - Changes the avatar of a member in a specific server.
 - `pk;member <name> privacy` - Displays a members current privacy settings.
 - `pk;member <name> privacy <subject> <public|private>` - Changes a members privacy setting.
 - `pk;member <name> proxy [tags]` - Changes the proxy tags of a member. use below add/remove commands for members with multiple tag pairs.
@@ -69,7 +90,7 @@ Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank.
 - `pk;group <group> add <member> [member 2] [member 3...]` - Adds one or more members to a group.
 - `pk;group <group> remove <member> [member 2] [member 3...]` - Removes one or more members from a group.
 - `pk;group <group> privacy <description|icon|visibility|all> <public|private>` - Changes a group's privacy settings.
-- `pk;group <group> icon [icon]` - Shows or changes a group's icon.
+- `pk;group <group> icon [icon url|@mention|upload]` - Shows or changes a group's icon.
 - `pk;group <group> delete` - Deletes a group.
 
 ## Switching commands
@@ -90,17 +111,18 @@ Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank.
 - `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 <on/off>` - Enables or disables [log cleanup](./staff/compatibility.md#log-cleanup).
+- `pk;logclean <on|off>` - Enables or disables [log cleanup](./staff/compatibility.md#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.
 
 ## Utility
 - `pk;random [-group]` - Shows the info card of a randomly selected member [or group] in your system.
-- `pk;message <message id / message link>` - Looks up information about a proxied message by its message ID or link.
+- `pk;message <message id|message link|reply>` - Looks up information about a proxied message by its message ID or link.
 - `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;permcheck [server id]` - [Checks the given server's permission setup](./staff/permissions.md#permission-checker-command) to check if it's compatible with PluralKit.
+- `pk;edit [message link|reply] <new content>` - 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!**
 
 ## API
 *(for using the [PluralKit API](./api-documentation.md), useful for developers)*
@@ -113,4 +135,4 @@ Words in **\<angle brackets>** or **[square brackets]** mean fill-in-the-blank.
 - `pk;system help` - Lists system-related commands.
 - `pk;member help` - Lists member-related commands.
 - `pk;switch help` - Lists switch-related commands.
-- `pk;commands` - Directs you to this page!
+- `pk;commands` - Shows inline command documentation, or directs you to this page.

docs/content/faq.md

@@ -66,7 +66,7 @@ No. This is a limitation in Discord itself, and cannot be changed. The color com
 * Discord sometimes has issues displaying avatars. We can't do anything about that, sorry :(
 
 ### Why can't I use nitro emoji in some channels?
-Webhooks inherit nitro emoji permissions from the @everyone role, so @everyone must have the "Use External Emoji" permission to be able to use nitro emoji with PluralKit.
+Webhooks inherit nitro emoji permissions from the `@everyone` role, so `@everyone` must have the "Use External Emoji" permission to be able to use nitro emoji with PluralKit.
 If it still doesn't work, make sure this permission isn't denied in channel overrides (found in channel settings -> permissions).
 
 ### Why can't I invite PluralKit to my server?

docs/content/tips-and-tricks.md

@@ -22,6 +22,8 @@ PluralKit has a couple of useful command shorthands to reduce the typing:
 |pk;system frontpercent|pk;s fp|
 |pk;member|pk;m|
 |pk;member new|pk;m n|
+|pk;group|pk;g|
+|pk;group new|pk;g n|
 |pk;switch|pk;sw|
 |pk;message|pk;msg|
 |pk;autoproxy|pk;ap|
@@ -63,8 +65,12 @@ You cannot look up private members of another system.
 |-with-created|-wc|Show each member's creation date|
 |-with-avatar|-wa, -wi, -ia, -ii, -img|Show each member's avatar URL|
 
+::: warning
+These flags only work with the full member list (`pk;system list full`).
+:::
+
 ## Miscellaneous flags
 |Command|Flag|Aliases|Description|
 |---|---|---|---|
-|pk;system frontpercent|fronters-only|fo|Hides the "no fronters" list item|
+|pk;system frontpercent|-fronters-only|-fo|Shows the system's frontpercent without the "no fronter" entry|
-|pk;group \<group> frontpercent|fronters-only|fo|Same as above, but for groups|
+|pk;group \<group> frontpercent|-fronters-only|-fo|Shows a group's frontpercent without the "no fronter" entry|

docs/content/user-guide.md

@@ -594,7 +594,7 @@ pk;import https://link/to/the/data/file.json
 ```
 *(alternatively, run `pk;import` by itself and attach the .json file)*
 
-Note that while Tupperbox supports features such as per-member system tags PluralKit does not. Pluralkit also does not currently support exporting/importing member groups. 
+Note that while Tupperbox supports features such as per-member system tags, PluralKit does not. PluralKit also does not currently support importing or exporting member groups.
 PluralKit will warn you when you're importing a Tupperbox file that makes use of such features, as they will not carry over. 
 
 ### Importing from PluralKit