[DOCS] Create Example Sections

[bobluppes]

Create Example Sections

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

I would like to add a few example sections to the documentation. Each example should be self-contained and should demonstrate a potential usage of the Graaf library.

If you are interested, you can pick an example from the proposals below, or (even better) suggest your own example. The scope of a PR is restricted to a single example.

Definition of Done

Each example should contain the following:

• A complete and self-contained example under examples/EXAMPLE_NAME/main.cpp.
  • To verify that the example compiles and runs.
  • This can be used to generate any graphics (via dot files) for the public documentation.
  • See the dot serialization example for inspiration.
• An entry on our public documentation.
  • A short description of the example, what is the use case and why is it typical.
  • A list of the Graaf algorithms and data structures which are demonstrated in the example. Here you can link to the respective algorithms page in the documentation.
  • Code pointers (in the form of code blocks) to the important sections of the example. It is not necessary to cover the entirety of the added main.cpp, but the most important concepts should be captured.
  • Non-trivial parts in the code blocks should be explained in-text.
  • Graphics (i.e. in the form of visualized dot files) can be used. Any graphics should go under `docs/static/img/examples/.
  • Instructions on how to build the documentation locally can be found on the wiki.
  • An example entry can be found here.

Proposed Examples

• Dot serialization
• Shortest path (directed graph)
• Shortest path (undirected graph) [@Hromz]
• Cycle detection [@Hromz]
• Social network use case
• Minimal CNN implementation
• ...

[Hromz]

Hey @bobluppes, i would like to work on examples for documentation. Can i try?

[bobluppes]

Hi @Hromz, of course, looking forward to your contribution!

Please note that we have slightly changed the format we use for the examples. There is now a single source file with the example code under examples/YOUR_EXAMPLE_NAME/. Additionally, there is a docusaurus entry explaining it. I have updated this in the original issue and added links to the wiki on how to build and host the documentation locally.

[Hromz]

Hey @bobluppes, I made PR #47. Can you take a look? Simple example that uses graph traversal and the shortest path. In the future, I will add better examples.

[Hromz]

@bobluppes can I work on cycle detection example?

[bobluppes]

@bobluppes can I work on cycle detection example?

Hi @Hromz, of course! Looking forward to your contribution :)

[arnav1203]

Hey There. I would like to contribute in your repository so kindly grant me permission to do so.

[bobluppes]

Hey There. I would like to contribute in your repository so kindly grant me permission to do so.

Hi @arnav1203, welcome to Graaf!
Of course! Would you be interested in working on the social network use case?

[Poornima2003]

can u plz assign me this issue , I would like to contribute to this issue .

[github-actions]

Stale issue message