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

Enhance Project Documentation for Clarity and Accessibility #2

Open
4tal opened this issue Apr 3, 2024 · 3 comments
Open

Enhance Project Documentation for Clarity and Accessibility #2

4tal opened this issue Apr 3, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@4tal
Copy link
Contributor

4tal commented Apr 3, 2024

The documentation of our project, including the README.md, CONTRIBUTE.md, and the CONTRIBUTE.md files located within each functionality folder, require comprehensive updates and enhancements.

Improving these documents is crucial for ensuring that contributors can easily understand the project's goals, how to get started, and how to contribute effectively.

@4tal 4tal added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 3, 2024
@martincarapia
Copy link

This should be closed because of commit 1aa0559 no?

@4tal
Copy link
Contributor Author

4tal commented Apr 4, 2024

@martincarapia 10q. While this commit has indeed addressed several aspects of the documentation, the issue at hand serves a broader purpose than just a one-time update. We aim to continuously enhance our documentation to ensure it remains aligned with the Grix Protocol’s evolving goals and vision. This includes not only making information more accessible and clearer but also ensuring it reflects the latest functionalities and architectural decisions.

Help us refine our approach, clarify our objectives, and make our project more welcoming to new contributors. So, while the specific updates in commit 1aa0559 are significant, this issue as an open invitation for continuous improvement rather than a task to be closed upon completion of certain updates.

@martincarapia
Copy link

Thank you for the clarification.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants