Skip to content

Commit 93c8603

Browse files
author
Suguru Hirahara
committed
Edit docs for bots: fix sentences in the usage sections
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
1 parent a6a5596 commit 93c8603

File tree

4 files changed

+12
-4
lines changed

4 files changed

+12
-4
lines changed

docs/configuring-playbook-bot-baibot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
383383

384384
## Usage
385385

386-
To use the bot, invite the `@baibot:example.com` bot user into a room.
386+
To use the bot, invite it to any existing Matrix room (`/invite @baibot:example.com` where `example.com` is your base domain, not the `matrix.` domain).
387387

388388
If you're an allowed bot [👥 user](https://github.com/etkecc/baibot/blob/main/docs/access.md#user) (see [👥 Initial users configuration](#-initial-users-configuration)), the bot will accept your invitation and join the room.
389389

docs/configuring-playbook-bot-buscarron.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,11 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
7575

7676
## Usage
7777

78-
To use the bot, invite the `@bot.buscarron:example.com` to the room you specified in a config, after that any point your form to the form url, example for the `contact` form:
78+
To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain).
79+
80+
After the bot joins the room, anyone can call the web form via HTTP POST method.
81+
82+
Here is an example for the `contact` form:
7983

8084
```html
8185
<form method="POST" action="https://buscarron.example.com/contact">

docs/configuring-playbook-bot-chatgpt.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
7070

7171
## Usage
7272

73-
To use the bot, invite the `@bot.chatgpt:example.com` to the room you specified in a config, after that start speaking to it, use the prefix if you configured one or mention the bot.
73+
To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.chatgpt:example.com` where `example.com` is your base domain, not the `matrix.` domain).
74+
75+
After the bot joins the room, you can send a message to it. When you do so, use the prefix if you configured it or mention the bot.
7476

7577
You can also refer to the upstream [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot).

docs/configuring-playbook-bot-honoroit.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
6666

6767
## Usage
6868

69-
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.
69+
To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @honoroit:example.com` where `example.com` is your base domain, not the `matrix.` domain).
70+
71+
After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room.
7072

7173
Send `!ho help` to the bot in the room to see the available commands.
7274

0 commit comments

Comments
 (0)