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

Updated readme.md #122

Merged
merged 7 commits into from
Oct 3, 2023
Merged

Conversation

LinhNguyenLe2109
Copy link
Contributor

@LinhNguyenLe2109 LinhNguyenLe2109 commented Oct 1, 2023

Changes

  • Moved About section to a new section call "How to use Graaf". I believe this title suit that section more
  • Add a new About section. When I first read the project I had no idea what this one was about. I had to search online for a definition
  • Moved "Installation" Section above "How to use...". I think this fits with the flow of most project more.
  • Updated all links in the "Algorithms section". Some of them are wrong urls, I updated them and added other links to improve user experince
  • Add a contributors list. It would be nice to see a list of people working on the project. Let me know if you think it's unnecessary

New found issues:

  • I find the the installation guide is not consistent, the one on README and the one on the doc are quite different. So what should I use? Should it be on the doc or the one on README? I believe we need clearer instruction.
  • In "How to use Graaf section", should we have a clearer guide and let the user actually create and see the result of the project? It would be nice if the user can perform some simple algorithms with their newly created graph

Let me know if you need any change.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hi there! Thank you for creating your first pull-request on the Graaf library :)

@codecov
Copy link

codecov bot commented Oct 1, 2023

Codecov Report

All modified lines are covered by tests ✅

📢 Thoughts on this report? Let us know!.

@LinhNguyenLe2109
Copy link
Contributor Author

@bobluppes HI can you see if the changes I made sufficent?

@bobluppes
Copy link
Owner

I find the the installation guide is not consistent, the one on README and the one on the doc are quite different. So what should I use? Should it be on the doc or the one on README? I believe we need clearer instruction.
In "How to use Graaf section", should we have a clearer guide and let the user actually create and see the result of the project? It would be nice if the user can perform some simple algorithms with their newly created graph

  • Good point on the installation guide, we should definitely update that 😅 I created Installation guide is inconsistent #125 for this
  • Regarding the "How to use Graaf section", that is also a good idea. Maybe we can reuse one of the examples there?

Copy link
Owner

@bobluppes bobluppes left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution, LGTM 🚀

@bobluppes bobluppes added documentation Improvements or additions to documentation hacktoberfest-accepted labels Oct 3, 2023
@bobluppes bobluppes merged commit 2554ea3 into bobluppes:main Oct 3, 2023
8 checks passed
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 hacktoberfest-accepted
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants