1
Fork 0
mirror of https://github.com/allthingslinux/tux.git synced 2024-10-02 16:43:12 +00:00
Commit graph

28 commits

Author SHA1 Message Date
kzndotsh
b46b24d258 docs(README.md): add Contributors section with contrib.rocks image to acknowledge contributors
docs(permissions.md): update file paths for Sys Admin and Bot Owner from config.json to config/settings.yml for better organization
docs(permissions.md): clarify Server Owner role description for better understanding
2024-09-08 05:57:59 +00:00
kzndotsh
20680eb502 chore: move docs/resources to assets/branding 2024-08-21 21:55:44 -04:00
kzndotsh
66fc66247c docs(README.md, development.md): update file references from .json to .yml to reflect changes in configuration file format
fix(development.md): correct .env.example to .env to accurately represent the environment file name
2024-08-22 01:45:57 +00:00
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
kzndotsh
1bf1642b5b docs(development.md): add detailed explanation about Cogs in the Cogs Primer section to provide better understanding for developers 2024-08-17 07:26:20 +00:00
kzndotsh
5632a90437 docs(development.md): add placeholders for new sections to provide more detailed information about different parts of the project in the future 2024-08-16 22:30:23 +00:00
kzndotsh
6e61e06165 feat(docs): add development.md to provide a guide for developers
refactor(database/controllers): remove db_controller instance from __init__.py to avoid circular imports
2024-08-16 22:18:59 +00:00
kzndotsh
09cf41fe04 docs: add CONTRIBUTING.md to guide contributors on how to contribute to the project 2024-08-05 14:23:18 +00:00
kzndotsh
edefd3a1df chore(archive): remove old files and update docs 2024-08-04 12:31:27 -04:00
clonidine
388e29f614
Update docs/CONTRIBUTING.md
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
2024-08-02 06:51:18 -03:00
clonidine
0c1f66d1b1
Update docs/CONTRIBUTING.md
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
2024-08-02 06:51:04 -03:00
clonidine
c7c2b4be65
docs: add CONTRIBUTING.md 2024-08-02 09:40:29 +00:00
kzndotsh
d70209b889 feat(README.md): add dynamic role-based permission system to feature list
docs(README.md): update installation steps to include bot run command
docs(commands.md): add new file to document bot commands
docs(services.md): add new file to document bot services
feat(info.py): add new cog for server, bot, and member info commands
feat(avatar.py): add new cog for avatar command to fetch user avatars

feat(membercount.py): add new MemberCount cog to show server member count
This new cog includes a command 'membercount' that shows the total number of members, humans, bots, and staff in the server.
2024-07-31 06:06:14 +00:00
kzndotsh
3fc6a5ee01 feat(docs): add MkDocs documentation with initial pages
chore(justfile): add commands to serve and build docs using MkDocs
feat(mkdocs.yml): add initial MkDocs configuration with Material theme
chore(pyproject.toml): add mkdocs-material as a dependency for docs group
2024-07-31 01:38:07 +00:00
kzndotsh
ad919afc14 feat(docs): add CLI.md, COG_STANDARDS.md, EMBED_STANDARDS.md to .archive directory
docs(CLI.md): provide instructions for installation, development, Docker, linting, formatting, and Git commands
docs(COG_STANDARDS.md): outline standards for creating or updating cogs for the Tux Discord bot
docs(EMBED_STANDARDS.md): establish standards and best practices for creating and utilizing Discord embeds

docs: add EMBED_USAGE.md, EVENT_STANDARDS.md, PROJECT_STRUCTURE.md to provide detailed guidelines and project structure information for contributors

feat(README.md): add dynamic permission system to feature list to reflect new functionality
docs(README.md): update installation steps to include running the bot
docs(PERMISSIONS.md): change permission level 0 from 'Everyone' to 'Member' for clarity
chore(docs/resources): remove unused image.png file from resources
2024-07-29 20:58:32 +00:00
kzndotsh
002e7d24b6 docs(PERMISSIONS.md): update permission levels to reflect changes in role hierarchy
refactor(schema.prisma): change perm_level_roles to perm_level_role_id for better clarity and consistency
refactor(config.py): update methods and messages to reflect changes in role handling
refactor(snippets.py): rename db_controller to db and config_db to config for better readability
refactor(snippets.py): update permission checks to use new perm_level_9_role_id
refactor(snippets.py): update db method calls to reflect new method names in DatabaseController

refactor(guild_config.py): reorganize methods under CRUD comments for better readability
feat(guild_config.py): add get_perm_level_role method to fetch role based on role type
feat(guild_config.py): add update_perm_level_role method to update role based on level
fix(guild_config.py): modify update_perm_level_role to use upsert instead of update for better data consistency
style(guild_config.py): remove commented out code for cleaner codebase
2024-07-28 19:46:56 +00:00
clonidine
14dcf51ea1
docs(PROJECT_STRUCTURE.md): remove 'mypy.ini' from doc
'mypy.ini' is no longer needed
2024-07-28 04:18:28 -03:00
kzndotsh
464a23af8e feat(settings.json): add PERMISSION_LEVELS object to manage user permissions more effectively
docs(PERMISSIONS.md): add new documentation file explaining the permissions management system
refactor(schema.prisma): simplify GuildConfig model by removing unnecessary fields and adding permission level roles fields for better permissions management

feat(config.py): add ConfigSelectMenu and ConfigSelectView classes for guild role configuration
refactor(config.py): replace individual role setting commands with a single command using the new classes
chore(config.py): comment out old role setting commands for reference, to be removed in future commits

refactor: consolidate channel setting commands into a single command for better maintainability
feat: add a new command to set all roles and channels using a select menu for improved user experience

feat: add role configuration options for different permission levels

This commit introduces the ability to configure roles for different permission levels (0-9) in the application. This allows for more granular control over user permissions and enhances the flexibility of the role management system.

refactor(client.py): conditionally set log_queries based on DEBUG constant for better control over logging in different environments

refactor(guild_config.py): simplify method and variable names for readability and maintainability
style(guild_config.py): improve code formatting for better readability

refactor(guild_config.py): simplify variable names by removing redundant 'guild_' prefix
chore(guild_config.py): comment out unused methods to improve code readability and performance

refactor(guild_config.py): simplify field names for better readability and consistency
feat(guild_config.py): comment out unused role retrieval methods to improve performance
chore(guild_config.py): add commented out code for future permission level roles feature

fix(main.py): uncomment debug related imports and function calls to enable debugging
feat(constants.py): change default value of DEBUG constant to True to enable debugging by default
2024-07-27 20:21:24 +00:00
kzndotsh
101e5100e9 style(README.md): replace CRLF line endings with LF for better cross-platform compatibility
docs: add PROJECT_STRUCTURE.md to provide an overview of the project structure
feat(sync.py): enable administrator permissions check for the sync command to ensure security
2024-04-11 19:24:07 +00:00
kzndotsh
c8dfb335ee docs(COG_STANDARDS.md): update command usage guidelines to include subcommands and role-based permissions
docs(COG_STANDARDS.md): add type hints recommendation for better code readability and maintainability
docs(COG_STANDARDS.md): add examples for prefix, slash, and group slash commands
docs(COG_STANDARDS.md): add guidelines for embeds and utility functions usage
docs(EMBED_USAGE.md): clarify that adding reactions is an example use case, not a mandatory step
2024-04-08 21:30:43 +00:00
kzndotsh
693001b7d5 feat(docs): add COG_STANDARDS.md to provide guidelines for cog creation
feat(docs): add EMBED_STANDARDS.md to establish standards for embed usage
chore(docs): remove EMBED_STANDARD.md as it's replaced by EMBED_STANDARDS.md

docs: add EMBED_USAGE.md and EVENT_STANDARDS.md to provide usage guidelines and best practices for EmbedCreator utility and event listeners
chore: remove unused __event_template__.py and base_cog.py from examples directory to clean up the codebase
build(pyproject.toml): add aioconsole and psutil to poetry dependencies for better async console handling and system monitoring
2024-04-08 21:12:54 +00:00
electron271
a098fad793
Update EMBED_STANDARD.md 2024-03-31 21:28:59 -05:00
electron271
d06c566880 begin simple embed standard 2024-03-29 18:24:53 -05:00
kzndotsh
65fea2f8d2 [Docs] Update README.md 2024-03-28 04:16:41 -04:00
kzndotsh
bbcd7651b6
Merge pull request #86 from allthingslinux/readme
[DOC] improved readme
2024-03-28 03:52:35 -04:00
kzndotsh
772eae6a2d [Refactor] Major changes to dir structure, temp removal of permissions, added loguru, added some async libs, improve types, clean pyproject config 2024-03-27 16:16:33 -04:00
kzndotsh
d98060e873 [Docs] Added CLI documentation for developer commands 2024-03-26 17:37:25 -04:00
electron271
de55473892 [DOC] improved readme 2024-03-24 17:37:47 -05:00