Skip to content

Commit

Permalink
Update fcontent of README.md and docs/index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
No767 committed Dec 11, 2023
1 parent 6325a8d commit 225a07b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 3 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Rodhaj

[![CodeQL](https://github.com/transprogrammer/rodhaj/actions/workflows/codeql.yml/badge.svg)](https://github.com/transprogrammer/rodhaj/actions/workflows/codeql.yml) [![Lint](https://github.com/transprogrammer/rodhaj/actions/workflows/lint.yml/badge.svg)](https://github.com/transprogrammer/rodhaj/actions/workflows/lint.yml) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=transprogrammer_rodhaj&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=transprogrammer_rodhaj) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=transprogrammer_rodhaj&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=transprogrammer_rodhaj)

A improved, modern version of ModMail for Transprogrammer

> [!IMPORTANT]
Expand All @@ -18,11 +20,11 @@ sends a direct message to the bot, Rodhaj will create a new ticket (which is a f
internally for staff to view. From there, each ticket is tied with a member and DMs from Rodhaj will be processed and sent to their respective tickets.

To ensure that staff will be able to respond, each active staff is randomly assigned
to a particular ticket. This ensures that tickets are evenly distributed among staff. Staff are free to swap and work on multiple tickets as needed. Once a ticket is closed, the staff will be automatically unassigned from the ticket, and a new DM to Rodhaj will prompt the user to create a new ticket.
to a particular ticket. This ensures that tickets are evenly distributed among staff. Staff are free to swap and work on multiple tickets as needed. Once a ticket is closed, the staff will be automatically unassigned from the ticket, and a new DM to Rodhaj will prompt the user to create a new ticket. It's designed to be a replacement to ModMail.

## Contributing

Contributions to Rodhaj are always welcomed. These could be as small as
changing documentation to adding new features. If you are interested to start
the process, please consult the [developer guide](CONTRIBUTING.md) before
the process, please consult the [contributing guidelines](.github/CONTRIBUTING.md) before
you get started.
11 changes: 10 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ but with a completely new, improved codebase and features. It works just like Re
where users can send messages to the bot and the bot will relay it to the server's staff team. This allows
for a process of communicating from user to staff to be streamlined, and securely done.

Features
--------

Rodhaj offers these features in addition to ones found on ModMail:

- Advanced tags system
- Automatic ticket assignment (with manual override)
- Modern touch using forum channels, webhooks, and best practices
- Customizable settings

What's Different?
-----------------
Expand All @@ -35,7 +44,7 @@ Thus, **this bot has no invite**.
Contributing
------------

If you would like to contribute to Rodhaj, please read the guides below.
If you would like to contribute to Rodhaj, please read the guide below.

- :doc:`dev-guide/index`

Expand Down

0 comments on commit 225a07b

Please sign in to comment.