refactor(config): update config.example.toml file

Author: Akinator31

.github/workflows/docs.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - 308-documentation
     paths:
       - 'docs/**'
       - '.github/workflows/docs.yml'

.run/Run.run.xml

@@ -0,0 +1,23 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="Run" type="CargoCommandRunConfiguration" factoryName="Cargo Command" nameIsGenerated="true">
+    <option name="buildProfileId" value="dev" />
+    <option name="command" value="run -p rustmail" />
+    <option name="workingDirectory" value="file://$PROJECT_DIR$" />
+    <envs>
+      <env name="RUSTFLAGS" value="--cfg tokio_unstable" />
+    </envs>
+    <option name="emulateTerminal" value="true" />
+    <option name="channel" value="DEFAULT" />
+    <option name="requiredFeatures" value="true" />
+    <option name="allFeatures" value="false" />
+    <option name="withSudo" value="false" />
+    <option name="buildTarget" value="REMOTE" />
+    <option name="backtrace" value="SHORT" />
+    <option name="isRedirectInput" value="false" />
+    <option name="redirectInputPath" value="" />
+    <method v="2">
+      <option name="ToolBeforeRunTask" enabled="true" actionId="Tool_External Tools_trunk" />
+      <option name="CARGO.BUILD_TASK_PROVIDER" enabled="true" />
+    </method>
+  </configuration>
+</component>

config.example.toml

@@ -1,57 +1,72 @@
 [bot]
-token = "TOKEN_HERE"
-status = "DM POUR SUPPORT"
-welcome_message = "Votre message à bien été reçu par l'équipe Staff ! Nous vous répondrons dès que possible."
-close_message = "Merci d'avoir contacté le support ! Ton ticket est désormais clos."
+token = "MTQyMjU1OTIyNjIwM.GWv0F5.v9sdNf59KZyWL0jVk_eqokcY-jnQ7X8upVBXYw"
+status = "DM FOR SUPPORT"
+welcome_message = "Message received! Our staff will get back to you as soon as possible."
+close_message = "Thank you for contacting support! Your ticket is now closed."
 typing_proxy_from_user = true
 typing_proxy_from_staff = true
 enable_logs = true
 enable_features = true
-logs_channel_id = 14043597305699
-features_channel_id = 14069404548593076
-panel_super_admin_users = []
+enable_panel = true
+client_id = 1422559226685450
+client_secret = "YWaq7VQM28PjfoNuWJPVpcs3gWFXI"
+redirect_url = "http://192.168.2.92:3002/api/auth/callback"
+timezone = "Europe/Paris"
+logs_channel_id = 14043597305635899
+features_channel_id = 14069404548309076
+ip = "http://192.168.2.92"
+panel_super_admin_users = [6891484871962727]
 panel_super_admin_roles = []
 
 [bot.mode]
-type = "dual"
-community_guild_id = 12096679805062590
-staff_guild_id = 711880297271856
+type = "single"
+guild_id = 7118802972311856
 
 [command]
 prefix = "!"
 
 [thread]
-inbox_category_id = 137646043847505960
+inbox_category_id = 1376460638505960
 embedded_message = true
 user_message_color = "3d54ff"
 staff_message_color = "ff3126"
 system_message_color = "00ff00"
 block_quote = true
 time_to_close_thread = 5
 create_ticket_by_create_channel = true
+close_on_leave = false
+auto_archive_duration = 10080
+
+[language]
+default_language = "fr"
+fallback_language = "en"
+supported_languages = [
+    "en",
+    "fr",
+    "es",
+    "de",
+]
+
+[error_handling]
+show_detailed_errors = false
+log_errors = true
+send_error_embeds = true
+auto_delete_error_messages = true
+error_message_ttl = 30
+display_errors = true
 
 [notifications]
 show_success_on_edit = false
 show_partial_success_on_edit = true
 show_failure_on_edit = true
 show_success_on_reply = false
 show_success_on_delete = false
-
-[logs]
-show_log_on_edit = true
-show_log_on_delete = true
-
-[language]
-default_language = "en"
-fallback_language = "en"
-supported_languages = ["en", "fr", "es", "de"]
+show_success = true
+show_error = true
 
 [reminders]
 embed_color = "ffb800"
 
-[error_handling]
-show_detailed_errors = false
-log_errors = true
-send_error_embeds = true
-auto_delete_error_messages = true
-error_message_ttl = 30
+[logs]
+show_log_on_edit = true
+show_log_on_delete = true

docs/book.toml

@@ -1,7 +1,7 @@
 [book]
 title = "Rustmail Documentation"
 description = "Documentation for Rustmail, a Discord modmail bot"
-authors = ["Rustmail Team"]
+authors = ["Akinator31"]
 language = "en"
 src = "."
 

docs/development/architecture.md

@@ -126,15 +126,16 @@ rustmail_types/src/
 
 ### Gateway Events
 
-Rustmail handles these Discord gateway events:
-
-| Event                     | Handler            | Purpose                   |
-|---------------------------|--------------------|---------------------------|
-| `message_create`          | Guild messages     | Process DMs and commands  |
-| `interaction_create`      | Guild interactions | Handle slash commands     |
-| `guild_member_add/remove` | Guild members      | Track user status         |
-| `typing_start`            | Typing proxy       | Forward typing indicators |
-| `ready`                   | Ready handler      | Initialize bot state      |
+Rustmail reacts to various Discord gateway events. Here are the main ones:
+
+| Event                | Handler                 | Purpose                   |
+|----------------------|-------------------------|---------------------------|
+| `ready`              | `ReadyHandler`          | Initialize bot state      |
+| `message_create`     | `GuildMessagesHandler`  | Process DMs and commands  |
+| `interaction_create` | `InteractionHandler`    | Handle slash commands     |
+| `typing_start`       | `TypingProxyHandler`    | Forward typing indicators |
+
+All event handlers are located in `rustmail/src/handlers/`.
 
 ### Commands System
 

docs/development/building.md

@@ -14,7 +14,7 @@ Install Rust via rustup:
 curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
 ```
 
-Minimum version: Rust 1.75+
+Minimum version: **Rust 1.85+** (Edition 2024)
 
 Verify installation:
 ```bash
@@ -77,23 +77,27 @@ Output: `target/release/rustmail`
 
 ```bash
 cd rustmail_panel
-trunk build --release
+trunk build --release --dist ../rustmail/static
 ```
 
-Output: `rustmail_panel/dist/`
+Output: `rustmail/static/`
 
-### Full Build
+### Full Build (Panel + Bot)
 
-```bash
-# Build bot
-cargo build -p rustmail --release
+The panel must be built first and placed in `rustmail/static/` so the bot can embed it:
 
-# Build panel
+```bash
+# Build panel and output to bot's static folder
 cd rustmail_panel
-trunk build --release
+trunk build --release --dist ../rustmail/static
 cd ..
+
+# Build bot (embeds the panel)
+cargo build -p rustmail --release
 ```
 
+Output: `target/release/rustmail` (single binary with embedded panel)
+
 ---
 
 ## Development Build
@@ -157,9 +161,9 @@ cargo fmt --all --check
 
 ## Build Optimization
 
-### Release Profile
+### Custom Release Profile
 
-The default release profile in `Cargo.toml`:
+You can add a custom release profile to your workspace `Cargo.toml` for optimized builds:
 
 ```toml
 [profile.release]
@@ -170,7 +174,7 @@ opt-level = 3
 
 ### Smaller Binary
 
-For reduced binary size:
+For reduced binary size, use:
 
 ```toml
 [profile.release]
@@ -180,6 +184,8 @@ codegen-units = 1
 opt-level = "z"
 ```
 
+Note: These profiles increase compile time but produce smaller/faster binaries.
+
 ---
 
 ## Cross-Compilation
@@ -293,6 +299,25 @@ cargo sqlx prepare --workspace
 
 ## IDE Setup
 
+### RustRover / IntelliJ
+
+The repository includes a pre-configured run configuration in `.run/Run rustmail.run.xml`.
+
+This configuration:
+1. Builds the panel with Trunk
+2. Outputs to `rustmail/static/`
+3. Runs the bot
+
+To use it:
+1. Open the project in RustRover
+2. Select "Run rustmail" from the run configurations dropdown
+3. Click Run
+
+The equivalent command:
+```bash
+cd rustmail_panel && trunk build --release --dist ../rustmail/static && cd .. && cargo run -p rustmail
+```
+
 ### VS Code
 
 Recommended extensions:
@@ -308,10 +333,6 @@ Settings (`.vscode/settings.json`):
 }
 ```
 
-### IntelliJ/CLion
-
-Install the Rust plugin. The project should be recognized automatically.
-
 ---
 
 ## Project Layout Reference
@@ -322,16 +343,20 @@ rustmail/
 ├── Cargo.lock              # Dependency lock file
 ├── rustmail/               # Main bot crate
 │   ├── Cargo.toml
-│   └── src/
-├── rustmail_panel/         # Panel crate
+│   ├── src/
+│   └── static/             # Panel build output (embedded)
+├── rustmail_panel/         # Web panel crate (Yew/WASM)
 │   ├── Cargo.toml
 │   ├── Trunk.toml
 │   ├── index.html
 │   └── src/
 ├── rustmail_types/         # Shared types crate
 │   ├── Cargo.toml
 │   └── src/
-├── migrations/             # Database migrations
+├── rustmail-i18n/          # Internationalization resources
+├── migrations/             # SQLite migrations
+├── docs/                   # Documentation (mdBook)
+├── .run/                   # IDE run configurations
 ├── config.example.toml     # Example configuration
 └── Dockerfile
 ```

docs/getting-started/first-steps.md

@@ -15,6 +15,7 @@ From your installation directory:
 ```
 
 On Windows:
+
 ```cmd
 rustmail.exe
 ```
@@ -24,10 +25,15 @@ rustmail.exe
 On successful startup, you will see:
 
 ```
-[INFO] Loading configuration...
-[INFO] Connecting to Discord...
-[INFO] Bot is ready!
-[INFO] Panel server running on http://0.0.0.0:3002
+[INFO] Database connection pool established
+[INFO] Database connected!
+[INFO] Starting rustmail...
+[INFO] listening on 0.0.0.0:3002
+[INFO] Configuration successfully validated!!
+[INFO] Mode: Mono server (ID: 711880297272311856)
+[INFO] Rustmail is online !
+[INFO] All pending reminders have been scheduled.
+[INFO] Updated 0 ticket statuses
 ```
 
 If there are configuration errors, the bot will display specific messages indicating what needs to be fixed.
@@ -38,7 +44,8 @@ If there are configuration errors, the bot will display specific messages indica
 
 ### 1. Check Bot Status
 
-In Discord, verify the bot appears online in your server's member list. Its status should display the text you configured in `bot.status`.
+In Discord, verify the bot appears online in your server's member list. Its status should display the text you
+configured in `bot.status`.
 
 ### 2. Test Slash Commands
 
@@ -48,16 +55,17 @@ In any channel where the bot has access:
 2. The bot should respond with a list of available commands
 
 If slash commands don't appear:
+
 - Wait a few minutes (Discord caches command registrations)
 - Verify the bot has the `applications.commands` scope
 - Check that the bot has permissions in the channel
 
 ### 3. Test Ticket Creation
 
-1. Send a direct message to the bot from a non-staff account
+1. Send a direct message to the bot
 2. The bot should:
-   - Reply with your configured `welcome_message`
-   - Create a new channel in your inbox category
+    - Reply with your configured `welcome_message`
+    - Create a new channel in your inbox category
 3. Staff can now respond using `/reply` or `!reply` in the ticket channel
 
 ### 4. Access the Panel (if enabled)
@@ -80,6 +88,7 @@ Failed to parse config.toml: ...
 ```
 
 Check your `config.toml` for:
+
 - Missing required fields
 - Incorrect TOML syntax (missing quotes, brackets)
 - Invalid color hex codes (should be 6 characters without `#`)
@@ -91,6 +100,7 @@ Serveur principal introuvable: ...
 ```
 
 Verify:
+
 - The guild IDs in your configuration are correct
 - The bot has been invited to all configured servers
 - You're using the server ID, not a channel or user ID
@@ -102,6 +112,7 @@ Verify:
 ```
 
 Either:
+
 - Set `enable_logs = false` to disable logging
 - Or provide a valid `logs_channel_id`
 
@@ -110,6 +121,7 @@ The same applies to `enable_features` and `features_channel_id`.
 ### OAuth2 Errors
 
 If the panel login fails:
+
 - Verify `client_id` and `client_secret` match your Discord application
 - Ensure `redirect_url` exactly matches what's configured in Discord Developer Portal
 - Check that your application has the OAuth2 redirect URI added