From e33bd16dc6870ff75d67c150352bd1359ec3a8e1 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 19 Dec 2024 03:24:04 +0900 Subject: [PATCH] Consistent "send help" messages The common pattern is "Send `.*?` to the bot (in the room) to see the available commands." If the descripions are about a bot being invited to a certain existing room or room which is not DM, then "in the room" is inserted among them. Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-baibot.md | 2 +- docs/configuring-playbook-bot-go-neb.md | 2 +- docs/configuring-playbook-bot-honoroit.md | 2 +- docs/configuring-playbook-bot-matrix-registration-bot.md | 2 +- docs/configuring-playbook-bridge-appservice-discord.md | 2 +- docs/configuring-playbook-bridge-go-skype-bridge.md | 2 +- docs/configuring-playbook-bridge-hookshot.md | 2 +- docs/configuring-playbook-bridge-mautrix-discord.md | 2 +- docs/configuring-playbook-bridge-mautrix-slack.md | 2 +- docs/configuring-playbook-bridge-mx-puppet-discord.md | 2 +- docs/configuring-playbook-bridge-mx-puppet-groupme.md | 2 +- docs/configuring-playbook-bridge-mx-puppet-instagram.md | 2 +- docs/configuring-playbook-bridge-mx-puppet-slack.md | 2 +- docs/configuring-playbook-bridge-mx-puppet-steam.md | 2 +- docs/configuring-playbook-bridge-mx-puppet-twitter.md | 2 +- docs/configuring-playbook-bridge-postmoogle.md | 2 +- docs/configuring-playbook-cactus-comments.md | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index 725c53a5a..a12af4608 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -391,7 +391,7 @@ After joining, the bot will introduce itself and show information about the [✨ If you've [🤖 configured one or more agents via Ansible](#-configuring-agents-via-ansible) and have [🤝 configured initial default handlers](#configuring-initial-default-handlers), the bot will immediately be able to make use of these agents for this new room. Otherwise, you will need to configure agents and/or handlers via chat commands. -Send `!bai help` to the room at any time to see the bot's help menu for additional commands. +Send `!bai help` to the bot in the room to see the available commands. You can also refer to the upstream [baibot](https://github.com/etkecc/baibot) project's documentation. diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index 5fa0ec6e3..f4e3222e9 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -238,6 +238,6 @@ To use the bot, invite it to any existing Matrix room (`/invite @bot.go-neb:exam Basic usage is like this: `!echo hi` or `!imgur puppies` or `!giphy matrix` -If you enabled the github_cmd service you can get the supported commands via `!github help` +If you enabled the github_cmd service, send `!github help` to the bot in the room to see the available commands. You can also refer to the upstream [Documentation](https://github.com/matrix-org/go-neb). diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index af31bbd00..979404b25 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -68,6 +68,6 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use To use the bot, invite the `@honoroit:example.com` to the room you specified in config, after that any Matrix user can send a message to the `@honoroit:example.com` to start a new thread in that room. -Send `!ho help` to the room to see the bot's help menu for additional commands. +Send `!ho help` to the bot in the room to see the available commands. You can also refer to the upstream [documentation](https://github.com/etkecc/honoroit#features). diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index 886c1e0dd..84c2e244e 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -52,7 +52,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). -In this room send `help` and the bot will reply with all options. +Send `help` to the bot to see the available commands. You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands). diff --git a/docs/configuring-playbook-bridge-appservice-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index 8dbf09474..2fecb6625 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -63,7 +63,7 @@ Then, follow the instructions in the help output message. If the bot is not already in the Discord server, follow the provided invite link. This may require you to be a administrator of the Discord server. -On the Discord side, you can say `!matrix help` to get a list of available commands to manage the bridge and Matrix users. +On the Discord side, send `!matrix help` to the bot to see the available commands for managing the bridge and Matrix users. **Note**: Encrypted Matrix rooms are not supported as of writing. diff --git a/docs/configuring-playbook-bridge-go-skype-bridge.md b/docs/configuring-playbook-bridge-go-skype-bridge.md index e5bcc450f..1b84e694f 100644 --- a/docs/configuring-playbook-bridge-go-skype-bridge.md +++ b/docs/configuring-playbook-bridge-go-skype-bridge.md @@ -33,4 +33,4 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use To use the bridge, you need to start a chat with `Skype bridge bot` with the handle `@skypebridgebot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). -Send `help` to the bot to see the commands available. +Send `help` to the bot to see the available commands. diff --git a/docs/configuring-playbook-bridge-hookshot.md b/docs/configuring-playbook-bridge-hookshot.md index 7df6f4992..57fd199fc 100644 --- a/docs/configuring-playbook-bridge-hookshot.md +++ b/docs/configuring-playbook-bridge-hookshot.md @@ -61,7 +61,7 @@ To use the bridge, you need to create a room and invite the Hookshot bot (`@hook Make sure the bot is able to send state events (usually the Moderator power level in clients). -Send `!hookshot help` to the room to see the bridge's help menu for additional commands. +Send `!hookshot help` to the bot to see the available commands. Refer to [Hookshot's documentation](https://matrix-org.github.io/matrix-hookshot/latest/usage.html) for more details about using the bridge's various features. diff --git a/docs/configuring-playbook-bridge-mautrix-discord.md b/docs/configuring-playbook-bridge-mautrix-discord.md index 061bcddd4..fbcd2b1e8 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/docs/configuring-playbook-bridge-mautrix-discord.md @@ -76,7 +76,7 @@ To acquire the token, open Discord in a private browser window. Then open the de 2. If you would like to login to Discord using a token, send `login-token` command, otherwise, send `login-qr` command. 3. You'll see a QR code which you need to scan with the Discord app on your phone. You can scan it with the camera app too, which will open Discord, which will then instruct you to scan it a 2nd time in the Discord app. 4. After confirming (in the Discord app) that you'd like to allow this login, the bot should respond with "Succcessfully authenticated as …" -5. Now that you're logged in, you can send a `help` command to the bot again, to see additional commands you have access to +5. Now that you're logged in, you can send `help` to the bot to see the available commands. 6. Some Direct Messages from Discord should start syncing automatically 7. If you'd like to bridge guilds: - send `guilds status` to see the list of guilds diff --git a/docs/configuring-playbook-bridge-mautrix-slack.md b/docs/configuring-playbook-bridge-mautrix-slack.md index 1794d9b72..19f0f75aa 100644 --- a/docs/configuring-playbook-bridge-mautrix-slack.md +++ b/docs/configuring-playbook-bridge-mautrix-slack.md @@ -63,7 +63,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use 1. Start a chat with `@slackbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). 2. If you would like to login to Slack using a token, send the `login-token` command, otherwise, send the `login-password` command. Read [here](https://docs.mau.fi/bridges/go/slack/authentication.html) on how to retrieve your token and cookie token. 3. The bot should respond with "Successfully logged into for team " -4. Now that you're logged in, you can send a `help` command to the bot again, to see additional commands you have access to. +4. Now that you're logged in, you can send `help` to the bot to see the available commands. 5. Slack channels should automatically begin bridging if you authenticated using a token. Otherwise, you must wait to receive a message in the channel if you used password authentication. ### 💡 Set up Double Puppeting diff --git a/docs/configuring-playbook-bridge-mx-puppet-discord.md b/docs/configuring-playbook-bridge-mx-puppet-discord.md index 92f697a13..cbc61c068 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-discord.md +++ b/docs/configuring-playbook-bridge-mx-puppet-discord.md @@ -43,4 +43,4 @@ Once logged in, send `list` to the bot user to list the available rooms. Clicking rooms in the list will result in you receiving an invitation to the bridged room. -Also send `help` to the bot to see the commands available. +Send `help` to the bot to see the available commands. diff --git a/docs/configuring-playbook-bridge-mx-puppet-groupme.md b/docs/configuring-playbook-bridge-mx-puppet-groupme.md index 8d5cca9d8..6a7f8bb97 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-groupme.md +++ b/docs/configuring-playbook-bridge-mx-puppet-groupme.md @@ -45,4 +45,4 @@ Once logged in, send `listrooms` to the bot user to list the available rooms. Clicking rooms in the list will result in you receiving an invitation to the bridged room. -Also send `help` to the bot to see the commands available. +Send `help` to the bot to see the available commands. diff --git a/docs/configuring-playbook-bridge-mx-puppet-instagram.md b/docs/configuring-playbook-bridge-mx-puppet-instagram.md index c710fe0d1..53375a029 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-instagram.md +++ b/docs/configuring-playbook-bridge-mx-puppet-instagram.md @@ -45,4 +45,4 @@ For double-puppeting, you probably want to issue these commands: If you are linking only one Instagram account, your `$puppetId` is probably 1, but use the `list` command find out. -The `help` command shows which commands are available, though at the time of writing, not every command is fully implemented. +Send `help` to the bot to see the available commands. At the time of writing, not every command is fully implemented. diff --git a/docs/configuring-playbook-bridge-mx-puppet-slack.md b/docs/configuring-playbook-bridge-mx-puppet-slack.md index 59244ae13..b8e8971b6 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-slack.md +++ b/docs/configuring-playbook-bridge-mx-puppet-slack.md @@ -48,4 +48,4 @@ Once logged in, send `list` to the bot user to list the available rooms. Clicking rooms in the list will result in you receiving an invitation to the bridged room. -Also send `help` to the bot to see the commands available. +Send `help` to the bot to see the available commands. diff --git a/docs/configuring-playbook-bridge-mx-puppet-steam.md b/docs/configuring-playbook-bridge-mx-puppet-steam.md index 91cf92fe9..18ea7ad22 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-steam.md +++ b/docs/configuring-playbook-bridge-mx-puppet-steam.md @@ -39,4 +39,4 @@ Once logged in, send `list` to the bot user to list the available rooms. Clicking rooms in the list will result in you receiving an invitation to the bridged room. -Also send `help` to the bot to see the commands available. +Send `help` to the bot to see the available commands. diff --git a/docs/configuring-playbook-bridge-mx-puppet-twitter.md b/docs/configuring-playbook-bridge-mx-puppet-twitter.md index d86b1c38f..be0df2305 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-twitter.md +++ b/docs/configuring-playbook-bridge-mx-puppet-twitter.md @@ -50,4 +50,4 @@ Once logged in, send `list` to the bot user to list the available rooms. Clicking rooms in the list will result in you receiving an invitation to the bridged room. -Also send `help` to the bot to see the commands available. +Send `help` to the bot to see the available commands. diff --git a/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index 86717c1f0..5aed1a144 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -71,7 +71,7 @@ To use the bridge, invite the `@postmoogle:example.com` bot user into a room you Then send `!pm mailbox NAME` to expose this Matrix room as an inbox with the email address `NAME@matrix.example.com`. Emails sent to that email address will be forwarded to the room. -Send `!pm help` to the room to see the bridge's help menu for additional commands. +Send `!pm help` to the bot in the room to see the available commands. You can also refer to the upstream [documentation](https://github.com/etkecc/postmoogle). diff --git a/docs/configuring-playbook-cactus-comments.md b/docs/configuring-playbook-cactus-comments.md index 2b7911810..b39387d86 100644 --- a/docs/configuring-playbook-cactus-comments.md +++ b/docs/configuring-playbook-cactus-comments.md @@ -82,7 +82,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use Upon starting Cactus Comments, a `bot.cactusbot` user account is created automatically. -To get started, send a `help` message to the `@bot.cactusbot:example.com` bot to confirm it's working. +To get started, send `help` to the `@bot.cactusbot:example.com` bot to confirm it's working. Then, register a site by sending `register ` (where `` is a unique identifier you choose. It does not have to match your domain). You will then be invited into a moderation room.