Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update README: Improve description, layout & formatting #634

Open
wants to merge 3 commits into
base: v4.2-dev
Choose a base branch
from

Conversation

ikergcalvino
Copy link

Summary:

This PR improves the project's README by refining its structure, enhancing readability, and correcting formatting inconsistencies. These changes aim to provide better clarity and a more professional layout for new and existing contributors. It is part of the ongoing improvements discussed in #627.

Changes introduced:

✅ Updated project description to provide a clearer overview.
✅ Improved layout for better readability and structure.
✅ Fixed formatting issues, such as spacing, headings, and lists.

This update enhances the documentation quality, making it more accessible and polished. 🚀

Copy link
Collaborator

@DaanSelen DaanSelen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see the JSON formatting has been sanitized. But regarding the Readme there is visually no difference. Can you elaborate on what the change in the readme is and why?

@ikergcalvino
Copy link
Author

Hey! Visually nothing changed, and in GitHub/VSCode the formatting wasn’t an issue, but some Markdown parsers had trouble with certain tags, and also with inconsistent indentation and non-self-closing tags. I cleaned up the structure to follow good practices, improving readability and ensuring better compatibility. Also pulled in the latest changes from main to prevent future merge conflicts (adding the missing Docker Pulls badge + Matrix.org chat link).

@DaanSelen
Copy link
Collaborator

Sounds good.

LGTM.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants