Improvements in the README.md documentation and new BRANCHES.txt file. #7590
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.
Description
This Pull Request introduces improvements to the Monica Personal CRM project's README, addressing concerns raised in various user-reported issues. New sections and subsections have been added to provide clearer information on key aspects of the repository, making it easier for new contributors to get involved.
Changes Made
The following changes have been implemented in response to issues reported by users and other documentation gaps identified:
✅ New "Next Updates" Section
Several issues referenced Chandler, but there was no mention of it in the project's documentation.
To address this lack of information, a new section has been created to provide context on Chandler and its relevance within the project.
✅ Subsections "How to Clone Git Repository" and "Command to Clone Git Repository"
Some users reported difficulties finding instructions on how to clone the repository in the main branch documentation.
In response, a subsection has been added with a direct link to the explanation of the git clone command within the project, along with a specific section providing the necessary command for cloning the repository.
✅ New "Branch Overview" Section
Although no specific issues were reported on this topic, we identified that the project's documentation does not specify the purpose of each branch, which may cause confusion for new contributors.
For example, deployment instructions are not in the main branch but in the 4.x branch, and this information is not documented anywhere.
To improve clarity, we have added this section to the README along with the BRANCHES.txt file, which documents the project's most important branches.
The community is invited to contribute additional information about the existing branches to keep the documentation updated and they can do it with the BRANCHES.txt file.
Motivation
These changes aim to enhance the clarity and usability of the official documentation, ensuring that new contributors have the necessary information to effectively participate in the project's development.
How to Review This Pull Request
📄 Review the modifications in README.md (the mentioned new sections and subsections).
📄 Check the BRANCHES.txt file, which has been added as part of this contribution.
BRANCHES.txt
Additional Comments
Suggestions and improvements to further optimize the project's documentation are welcome.