[skip ci] Clean up the docs

Author: No767

CONTRIBUTING.md

@@ -0,0 +1,103 @@
+# Contributing
+
+This document goes over the process of contributing, and the setup instructions.
+
+## Development
+
+### Software Requirements
+
+- Git
+- Poetry
+- Python
+- Docker
+- Discord Account + App
+
+> [!WARNING]
+> Rodhaj is natively developed on Linux, and is known to work on Linux and MacOS. 
+> Development should work on Windows but is highly untested.
+
+### Setup Instructions
+
+1. Ensure that you have a separate development bot and server before continuing. 
+
+2. Fork and clone the repo
+
+    ```bash
+    git clone https://github.com/[username]/rodhaj
+    ```
+
+    Alternatively, you can use the `gh` tool to clone the repo:
+
+    ```bash
+    gh repo clone https://github.com/[username]/rodhaj
+    ```
+
+> [!NOTE]
+> Ensure that you are in the cloned repo before continuing
+
+3. Copy the ENV template into the `bot` directory
+
+    ```bash
+    cp envs/dev.env bot/.env
+    ```
+
+4. Install the dependencies
+
+    ```bash
+    poetry install
+    ```
+
+5. Configure the settings in the ENV file (Note that the user that is created in the Docker container is `rodhaj`)
+
+6. Run the migrations
+
+    If this is the first time setting up the PostgreSQL server:
+
+    ```bash
+    poetry run python bot/migrations.py init
+    ```
+
+    If you are already have migrations set, then upgrade:
+
+    ```bash
+    poetry run python bot/migrations.py upgrade
+    ```
+
+7. Launch the bot
+
+    ```bash
+    poetry run python bot/launcher.py
+    ```
+
+> Where are the slash commands? See the [FAQ](CONTRIBUTING.md#-Where-are-the-slash-commands?)
+
+
+
+### PostgreSQL Setup (If you are not using Docker)
+
+If you are not using Docker, then you'll need to manually create and set up the database.
+The following SQL queries set up the user and database
+
+```sql
+CREATE ROLE rodhaj WITH LOGIN PASSWORD 'somepass';
+CREATE DATABASE rodhaj OWNER rodhaj;
+```
+
+You'll need to activate the `pg_trgm` extension within the `rodhaj` database.
+
+```sql
+CREATE EXTENSION IF NOT EXISTS pg_trgm;
+```
+
+## FAQ
+
+### Where are the slash commands?
+
+> TL;DR
+> Manually sync using Umbra's Sync Command (`r>sync <guild_id`)
+
+Unlike other frameworks, discord.py **does not** automatically sync slash commands to Discord. 
+Slash commands are commands that need to be sent to Discord, and they take care of the rest.
+As a result, you'll need to manually sync using [Umbra's Sync Command](https://about.abstractumbra.dev/discord.py/2023/01/29/sync-command-example.html),
+which is included in the bot.
+See [this gist](https://gist.github.com/No767/e65fbfdedc387457b88723595186000f) for more detailed information.

README.md

@@ -1,76 +1,17 @@
-# rodhaj
+# Rodhaj
+
+Transprogrammer's custom "ModMail" bot
+
 proto-repo for discord app
 
 **later down the road, pls do not push to main branch directly**
 
 ## Stuff that needs to be done
 
 - [x] Paginators
-- [ ] R. Danny migrations or asyncpg-trek
+- [x] R. Danny migrations or asyncpg-trek
 - [ ] The features
 
-## Getting Started
-
-### Preface on Slash Commands
-
-Unlike other frameworks, discord.py does not automatically sync slash commands (if you want to learn more why, see [this and why Noelle is heavily against it](https://github.com/No767/Zoee#preface-on-slash-commands-and-syncing)). So the way to sync is by using an prefixed commands, which is [Umbra's Sync Command](https://about.abstractumbra.dev/discord.py/2023/01/29/sync-command-example.html). More than likely you'll need to read up on how this slash command works in order to get started. In short, you'll probably want to sync your test bot to the guild instead (as demostrated here):
-
-```
-# Replace 1235 with your guild id
-r>sync 1235
-```
-
-### PG Setup
-If you want to run postgres on an docker compose stack,
-then all you need to do is to make an `.env` file in the root of the repo,
-and add these:
-
-```bash
-POSTGRES_PASSWORD=password
-POSTGRES_USER=user
-POSTGRES_DB=user
-```
-
-The values above set up the root postgres user. Ideally you will want to make an new user, which can be done like so:
-
-```sql
-CREATE ROLE rodhaj WITH LOGIN PASSWORD 'somepass';
-CREATE DATABASE rodhaj OWNER rodhaj;
-```
-
-### Setup Instructions
-
-You must have these installed:
-
-- Poetry
-- Python
-- Git
-- PostgreSQL
-
-1. Clone the repo or use it as a template.
-2. Copy over the ENV file template to the `bot` directory
-
-    ```bash
-    cp envs/dev.env bot/.env
-    ```
-3. Install the dependencies
-
-    ```bash
-    poetry install
-    ```
-
-4. Configure the settings in the ENV (note that configuring the postgres uri is required)
-
-5. Run the bot
-    
-    ```bash
-    poetry run python bot/launcher.py
-    ```
-
-6. Once your bot is running, sync the commands to your guild. You might have to wait a while because the syncing process usually takes some time. Once completed, you should now have the `CommandTree` synced to that guild. 
+## Contributing
 
-    ```
-    # Replace 12345 with your guild id
-    r>sync 12345 
-    ```
-7. Now go ahead and play around with the default commands. Add your own, delete some, do whatever you want now.
+See [contributing](./CONTRIBUTING.md)

docker-compose-dev.yml

@@ -5,7 +5,7 @@ services:
     container_name: Rodhaj-Postgres
     image: postgres:15 
     env_file:
-      - .env
+      - bot/.env
     volumes:
       - postgres_volume:/var/lib/postgresql/data
     ports:

envs/dev.env

@@ -5,5 +5,12 @@ TOKEN=token
 # IF YOU ARE RUNNING A PRODUCTION BUILD, SET THIS TO False!!
 DEV_MODE=True
 
+# Docker PostgreSQL root credientials
+POSTGRES_USER=postgres
+POSTGRES_PASSWORD=password
+
+# Account for the rodhaj user on PostgreSQL
+RODHAJ_PASSWORD=password
+
 # PostgreSQL URI string
-POSTGRES_URI=postgresql://user:password@localhost:5432/user
+POSTGRES_URI=postgresql://user:password@localhost:5432/user