Improve documentation

[bobluppes]

This is an open-ended ticket and we welcome multiple PRs.

In general, it would be nice to go over our documentation in the following locations:

• README.md
• In-code documentation on:
  • The core data structures in include/graaflib/graph.h, include/graaflib/edge.h, and include/graaflib/types.h
  • The algorithms in include/graaflib/algorithm/**/*.h
• The user-facing algorithm documentation in docs/docs/algorithms/**/*.md. This documentation can also be viewed here.

In particular it would be great if we can fix any spelling/grammar issues, as well as clarify anything which might be unclear to you on the documentation.

[Harsh-710]

Hey @bobluppes, I want to work on this issue. Can you assign it to me?

[LinhNguyenLe2109]

Hello @bobluppes, I have knowledge about graph and edge, can I work on that section?

[bobluppes]

Hi @LinhNguyenLe2109 @Harsh-710, welcome to Graaf!

Since we accept multiple PRs on this issue I will assign it to the both of you! To avoid potential merge conflicts, what do you think about @Harsh-710 working on the in-code documentation while @LinhNguyenLe2109 takes a look at the readme and user facing docs?

We can swap this afterwards as well, just trying to avoid merge conflicts :)

Let me know what you think

[SusovanDas19]

hi sir, can I do this?

[LinhNguyenLe2109]

Hello @bobluppes, yeah that's a good idea, I find the doc really hard to get a hang of the project and want more information to it so people can find it easier to use. I'll try to work with the readme file first, if I don't understand anything, I'll reach out to you on Discord

[ayushmankoley]

Hey would love to contribute
The core data structures in include/graaflib/graph.h, include/graaflib/edge.h, and include/graaflib/types.h

[LinhNguyenLe2109]

Hello @bobluppes, I believe I can only do with the readme file. I sent you a PR for that one. The set up process for C++ using VS code really takes a long time though.

[ankitrout2903]

Hey assign me this issue

[bobluppes]

Hi @SusovanDas19 @ayushmankoley @ankitrout2903, are you still up for this.
We are accepting multiple PRs on this issue, so if you want feel free to open a PR for any improvements you may have :)

[github-actions]

Stale issue message

[GovindaRohith]

Can you assign me to this?

[DaryaYuk]

@bobluppes Hi! I am a technical writer and I would like to improve the Readme file. If you still need help, please assign me to work on this issue

[bobluppes]

@bobluppes Hi! I am a technical writer and I would like to improve the Readme file. If you still need help, please assign me to work on this issue

Hi @DaryaYuk and welcome to Graaf!
Of course, new contributions are always welcome! Congrats on the first PR already, I will have a look shortly

[github-actions]

Stale issue message