refactor(readme): clear rewriting of readme#174
Merged
Akinator31 merged 3 commits intomainfrom Oct 8, 2025
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request significantly restructures the documentation for the Rustmail project to improve clarity, usability, and maintainability. The main
README.mdis simplified, with detailed sections about commands and setup moved to new dedicated documentation files. Additionally, configuration and feature documentation are updated to reflect recent changes, such as the addition of reminders.Key documentation and configuration changes:
Documentation Restructuring:
README.mdis streamlined to provide a high-level overview, warnings, and links to new, focused documentation files for setup and commands. Most detailed usage, configuration, and feature explanations are now indocs/setup.mdanddocs/commands.md.New Documentation Files:
docs/commands.mdwith comprehensive tables and explanations for both slash and text commands, including usage examples and descriptions for each command.docs/setup.mdwith step-by-step instructions for installing, configuring, and running Rustmail, including links to the example configuration and release downloads.Configuration Updates:
config.example.tomlto add a[reminders]section with anembed_colorsetting, reflecting new or upcoming reminder features.Support and Contribution Guidance:
README.mdnow includes a clear support section directing users to the Discord server for help, and retains contribution and warning notices.These changes make the documentation more modular and user-friendly, and prepare the project for future feature expansion.