docs(readme): modernize README structure and link wiki setup guides#11
Merged
docs(readme): modernize README structure and link wiki setup guides#11
Conversation
There was a problem hiding this comment.
Pull request overview
This PR modernizes the README.md structure to improve readability and usability for new users and contributors. It reorganizes the existing content into clearer sections, adds practical troubleshooting guidance, and redirects detailed setup instructions to wiki-based guides.
Changes:
- Restructured README with improved organization (What Is Included, Requirements table, Installation, Updating, Documentation and Support, Contributing, Troubleshooting, Mail Namespace Migration Notes)
- Replaced non-existent local setup doc reference with wiki-based setup guides (EN and DE)
- Added troubleshooting section covering common setup/runtime issues
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.
Purpose
Related Features / Issues
Overview of Changes
README.mdinto a cleaner, reviewer-friendly structure.QA / Verification
composer run ci:lint: not run (docs-only change)composer run test: not run (docs-only change)composer run analyse: not run (docs-only change)composer run cs-check: not run (docs-only change)Deployment Impact
Reviewer Focus
Checklist