-
Notifications
You must be signed in to change notification settings - Fork 346
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
Enhanced README: Contribution Guidelines, TOC, and Overview #2504
base: main
Are you sure you want to change the base?
Conversation
…ation guides, contribution guides, and TOC
1. ''' | ||
git clone https://github.com/matrix-org/matrix.org.git | ||
cd matrix.org |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to not be working with Github Markdown. Could you fix that please? Have a look at the rich diff button on the top right of this file to see how it is being rendered
''' | ||
zola build | ||
''' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as the other comment
''' | ||
git checkout -b <yourBranchName> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as the other comment
3. Create a new branch and implement changes using | ||
''' | ||
git checkout -b <yourBranchName> | ||
4. Submit a pull request (PR) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
4. Submit a pull request (PR) | |
4. Submit a pull request |
# Contact Us | ||
|
||
## Community | ||
If you have any questions about the project or your contribution, you may join the various community chats on https://matrix.to/#/#matrix.org-website:matrix.org |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you have any questions about the project or your contribution, you may join the various community chats on https://matrix.to/#/#matrix.org-website:matrix.org | |
If you have any questions about the project or your contribution, you may join our room https://matrix.to/#/#matrix.org-website:matrix.org |
[#matrix.org-website:matrix.org](https://matrix.to/#/#matrix.org-website:matrix.org). | ||
# Overview | ||
|
||
Matrix.org is a decentralized, open standard for real-time communication which allows users to collaborate in public and private rooms over IP. Matrix's purpose is to allow users to text and call without thinking about what app or phone the other user has. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Matrix.org is a decentralized, open standard for real-time communication which allows users to collaborate in public and private rooms over IP. Matrix's purpose is to allow users to text and call without thinking about what app or phone the other user has. | |
Matrix.org is an open standard for decentralised, secure communications while also allowing you to bridge to other networks easily. | |
This Repository covers our main website. | |
For spec please take a look at https://github.com/matrix-org/matrix-spec | |
For the conference website take a look at https://github.com/matrix-org/matrix-conf-website |
Descriptive Overview: Added a detailed intro about Matrix.org, emphasizing its purpose.
Build Instructions: Provided detailed step-by-step instructions for building the website
Table of Contents: Added a table of contents to make navigation through the various sections easier
Contribution Guidelines: Created a clear section for contribution and added steps for how to start contributing to this open-source project.