From 35ba387c8dd300eedc294cbe4d71fd162f53c625 Mon Sep 17 00:00:00 2001 From: Essem Date: Tue, 13 May 2025 15:59:26 -0500 Subject: [PATCH] docs: Attempt formatting --- docs/bun.md | 1 + docs/containers.md | 11 +++++------ docs/custom-commands.md | 1 + docs/postgresql.md | 13 ++++++++++--- 4 files changed, 17 insertions(+), 9 deletions(-) diff --git a/docs/bun.md b/docs/bun.md index a217f5ea..6190a9f7 100644 --- a/docs/bun.md +++ b/docs/bun.md @@ -3,6 +3,7 @@ [Bun](https://bun.sh) is a JavaScript and TypeScript runtime that aims to be performant while retaining compatibility with Node.js applications and modules. This page exists to document details about esmBot when running on Bun. !!! warning + Bun support is still very experimental and prone to bugs. If you find any issues while running the bot on Bun, please test if the same issue occurs on Node; if it doesn't, then specify that it's a Bun-specific issue and provide the version you used (you can find this by running `bun --version`). ## Setup diff --git a/docs/containers.md b/docs/containers.md index 31094602..6cf43cfc 100644 --- a/docs/containers.md +++ b/docs/containers.md @@ -22,22 +22,21 @@ You should then modify the `config/servers.json` file to change the IP addresses ```json { - "lava": [ - { "name": "localhost", "url": "lavalink:2333", "auth": "youshallnotpass" } - ], - "image": [ - { "server": "api", "auth": "verycoolpass100", "tls": false } - ] + "lava": [{ "name": "localhost", "url": "lavalink:2333", "auth": "youshallnotpass" }], + "image": [{ "server": "api", "auth": "verycoolpass100", "tls": false }] } ``` Finally, start the bot by running the following command (click to select your container runtime): === "Podman" + ```sh podman-compose up -d ``` + === "Docker" + ```sh docker compose up -d ``` diff --git a/docs/custom-commands.md b/docs/custom-commands.md index 22b706f2..5a6b0a35 100644 --- a/docs/custom-commands.md +++ b/docs/custom-commands.md @@ -24,6 +24,7 @@ commands/ As you can see, each command is grouped into categories, which are represented by subdirectories. To create a new category, you can simply create a new directory inside of the `commands` directory, and to create a new command, you can create a new JS file under one of those subdirectories. !!! tip + The `message` and `user` categories are special; instead of being registered as classic or slash commands, commands in these categories are registered as right-click context menu commands. Commands in the `message` category show when selecting messages, while commands in the `user` category show when selecting users. ## Command Structure diff --git a/docs/postgresql.md b/docs/postgresql.md index 4249afc8..2d5f6a7e 100644 --- a/docs/postgresql.md +++ b/docs/postgresql.md @@ -5,29 +5,36 @@ Here are some instructions for setting up PostgreSQL for use with esmBot. ### 1. Install PostgreSQL. === "Debian/Ubuntu" + ```sh sudo apt-get install postgresql postgresql-client ``` + === "Fedora/RHEL" + ```sh sudo dnf install postgresql postgresql-server ``` + === "Alpine" + ```sh doas apk add postgresql ``` + === "Arch/Manjaro" + ```sh sudo pacman -S postgresql ``` -*** +--- ### 2. (Optional) Tune PostgreSQL. [PGTune](https://pgtune.leopard.in.ua/) is a useful tool for generating configuration files for your PostgreSQL database. It is highly recommended that you generate a config using this tool as it can increase stability and performance. -*** +--- ### 3. Create the bot user and database. @@ -60,7 +67,7 @@ ALTER DATABASE esmbot OWNER TO esmbot; You're done! -*** +--- ### Troubleshooting -- 2.51.2