Skip to content

Commit ff8908a

Browse files
committed
refactor(readme): add documention website link to readme
1 parent b8e8d2e commit ff8908a

5 files changed

Lines changed: 23 additions & 22 deletions

File tree

.github/workflows/docs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ on:
44
push:
55
branches:
66
- main
7-
- 308-documentation
87
paths:
98
- 'docs/**'
109
- '.github/workflows/docs.yml'

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@
1818

1919
## Overview
2020

21-
Rustmail is a Discord modmail bot that enables staff teams to manage support tickets through private channels. Users send direct messages to the bot, which creates dedicated channels for staff to respond and track conversations.
21+
Rustmail is a Discord modmail bot that enables staff teams to manage support tickets through private channels. Users
22+
send direct messages to the bot, which creates dedicated channels for staff to respond and track conversations.
2223

2324
### Key Features
2425

@@ -56,18 +57,18 @@ The bot creates its SQLite database automatically on first run.
5657

5758
## Documentation
5859

59-
| Section | Description |
60-
|---------|-------------|
61-
| [Installation](docs/getting-started/installation.md) | Download and setup instructions |
62-
| [Configuration](docs/getting-started/configuration.md) | Detailed configuration guide |
63-
| [Commands](docs/guides/commands.md) | Complete command reference |
64-
| [Server Modes](docs/guides/server-modes.md) | Single vs dual-server setup |
65-
| [Web Panel](docs/guides/panel.md) | Administration panel guide |
66-
| [API Reference](docs/reference/api.md) | REST API documentation |
67-
| [Docker Deployment](docs/deployment/docker.md) | Container deployment |
68-
| [Architecture](docs/development/architecture.md) | Technical overview |
60+
| Section | Description |
61+
|--------------------------------------------------------|---------------------------------|
62+
| [Installation](docs/getting-started/installation.md) | Download and setup instructions |
63+
| [Configuration](docs/getting-started/configuration.md) | Detailed configuration guide |
64+
| [Commands](docs/guides/commands.md) | Complete command reference |
65+
| [Server Modes](docs/guides/server-modes.md) | Single vs dual-server setup |
66+
| [Web Panel](docs/guides/panel.md) | Administration panel guide |
67+
| [API Reference](docs/reference/api.md) | REST API documentation |
68+
| [Docker Deployment](docs/deployment/docker.md) | Container deployment |
69+
| [Architecture](docs/development/architecture.md) | Technical overview |
6970

70-
Full documentation is available in the [docs](docs/) directory.
71+
Full documentation is available in the [docs](docs/) directory or on the [website](https://docs.rustmail.rs).
7172

7273
---
7374

@@ -81,4 +82,5 @@ For help and discussions, join the [Discord server](https://discord.gg/9Bzma6Swt
8182

8283
This project is licensed under the [AGPLv3 License](LICENSE).
8384

84-
The `rustmail_panel` i18n module includes code derived from [i18n-rs](https://github.com/opensass/i18n-rs), licensed under MIT.
85+
The `rustmail_panel` i18n module includes code derived from [i18n-rs](https://github.com/opensass/i18n-rs), licensed
86+
under MIT.

docs/getting-started/first-steps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ Check your `config.toml` for:
9696
### Invalid Server ID
9797

9898
```
99-
Serveur principal introuvable: ...
99+
Main server not found: ...
100100
```
101101

102102
Verify:

docs/reference/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ List tickets with pagination and filtering.
255255
| `id` | string | - | Get a specific ticket by ID |
256256
| `page` | int | 1 | Page number |
257257
| `page_size` | int | 50 | Items per page (max 200) |
258-
| `status` | int | 0 | Filter: `0` = open, `1` = closed |
258+
| `status` | int | 1 | Filter: `1` = open, `0` = closed |
259259
| `category_id` | string | - | Filter by category ID |
260260
| `sort_by` | string | created_at | Sort field: `created_at`, `closed_at`, `user_name` |
261261
| `sort_order` | string | DESC | Sort order: `asc` or `desc` |

docs/reference/configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,14 @@ Required when `enable_panel = true`.
5353

5454
### Network
5555

56-
| Option | Type | Required | Default | Description |
57-
|--------|--------|----------|---------------|----------------------------------|
58-
| `ip` | string | No | Auto-detected | IP address for panel URL display |
56+
| Option | Type | Required | Default | Description |
57+
|--------|--------|----------|---------------|--------------------------------------|
58+
| `ip` | string | No | Auto-detected | Network interface to bind the server |
5959

60-
**Note:** The `ip` field only affects what address is displayed for panel access. The server always binds to `0.0.0.0:3002`. Set this manually when:
60+
**Note:** The server attempts to bind to the configured IP address. If the IP is invalid or unavailable, it falls back to `0.0.0.0:3002` (all interfaces). Set this manually when:
61+
- Running in Docker with host networking
6162
- Auto-detection returns wrong interface
62-
- Running in Docker with custom networking
63-
- You want to show a specific LAN address
63+
- You need to bind to a specific network interface
6464

6565
### Panel Administrators
6666

0 commit comments

Comments
 (0)