1
Fork 0
mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00
tux/docs/services.md
kzndotsh 8fcebd00be docs(CODE_OF_CONDUCT.md, CONTRIBUTING.md): wrap email and URLs in angle brackets for better markdown rendering
refactor(CONTRIBUTING.md): improve document structure and readability by adding indentation and spacing
style(CONTRIBUTING.md): add newline at end of file to adhere to POSIX standards

feat: add .markdownlint.yaml for consistent markdown formatting

This commit adds a .markdownlint.yaml configuration file to enforce consistent markdown formatting across the project. This will help maintain readability and uniformity in all markdown files.

docs: improve readability and clarity of project documentation

- README.md: Simplify title and subtitle formatting, add warning about bot readiness, clarify installation steps, and improve overall readability.
- cli.md: Improve readability by adding line breaks.
- commands.md: Remove unnecessary line break.
- development.md: Simplify introduction, refer to README for installation instructions, and improve readability.
- permissions.md: Improve readability by adding line breaks and clarifying permission levels.

style(services.md): improve readability by adding a line break between two sentences
docs(services.md): add newline at end of file to adhere to POSIX standards
2024-08-17 08:27:13 +00:00

1 KiB

Services

Overview

Services within the context of this bot are background tasks that run continuously and provide various functionalities to the server.

They are typically not directly interacted with by users, but rather provide additional features to the server that are not covered by commands.

Available Services

  • TTY Roles: Assigns roles to users based on the member count of the server to act as a vanity metric for how long a user has been a member of the server.
  • Harmful Message Detection: Detects harmful CLI commands in messages and warns users about them.
  • Temp Voice Channels: Automatically creates temporary voice channels for users to use and deletes them when they are empty.

Planned Services

  • Auto Welcome: Sends a welcome message to new members when they join the server.
  • Auto Role: Assigns a role to new members when they join the server.
  • Auto Mod: Automatically moderates the server by enforcing rules and restrictions
  • Auto Unban: Automatically unbans users after a specified duration