Selaa lähdekoodia

Edit docs for bots: fix sentences in the usage sections

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3895/head
Suguru Hirahara 1 vuosi sitten
vanhempi
commit
93c860305f
No known key found for this signature in database GPG Key ID: E4F9743DAB4B7B75
4 muutettua tiedostoa jossa 12 lisäystä ja 4 poistoa
  1. +1
    -1
      docs/configuring-playbook-bot-baibot.md
  2. +5
    -1
      docs/configuring-playbook-bot-buscarron.md
  3. +3
    -1
      docs/configuring-playbook-bot-chatgpt.md
  4. +3
    -1
      docs/configuring-playbook-bot-honoroit.md

+ 1
- 1
docs/configuring-playbook-bot-baibot.md Näytä tiedosto

@@ -383,7 +383,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

## Usage

To use the bot, invite the `@baibot:example.com` bot user into a room.
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).

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.



+ 5
- 1
docs/configuring-playbook-bot-buscarron.md Näytä tiedosto

@@ -75,7 +75,11 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

## Usage

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:
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).

After the bot joins the room, anyone can call the web form via HTTP POST method.

Here is an example for the `contact` form:

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


+ 3
- 1
docs/configuring-playbook-bot-chatgpt.md Näytä tiedosto

@@ -70,6 +70,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

## Usage

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.
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).

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.

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

+ 3
- 1
docs/configuring-playbook-bot-honoroit.md Näytä tiedosto

@@ -66,7 +66,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use

## Usage

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.
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).

After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room.

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



Ladataan…
Peruuta
Tallenna