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

[Doc] [Improvement] Provide tutorials on using GraphAr libraries in documentation #168

Open
lixueclaire opened this issue May 24, 2023 · 3 comments
Labels
Component:Documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@lixueclaire
Copy link
Contributor

lixueclaire commented May 24, 2023

Is your feature request related to a problem? Please describe.
The GraphAr project currently offers the C++ library and the Spark library, with "Getting Started" and "API References" available in the documentation. However, these references may not suffice for developers to quickly and intuitively understand the usage of the libraries.

Describe the solution you'd like
To address this, we propose adding tutorials on how to use the libraries in the documentation. These tutorials can be organized by programming language and separated into independent units for introducing different classes. As a first step, we can add tutorials on Info classes, such as GraphInfo, VertexInfo, and EdgeInfo.

For reference, we recommend to read Apache Arrow's documentation to learn about how to write the tutorials.

This is also a good first issue to get familiar with and get into making contributions to the GraphAr libraries.

@acezen
Copy link
Contributor

acezen commented Jan 26, 2024

some tutorial need to add:
[ ] How to convert csv format dataset to GraphAr with C++ SDK
[ ] How to convert csv format dataset to GraphAr with Spark SDK

@silspo
Copy link

silspo commented Nov 10, 2024

Hi , Would love to work on this , as it would also help me understand the stack faster while I build the tutorial. Can I pick this one up ? Thank You!

@Thespica
Copy link
Contributor

Hi , Would love to work on this , as it would also help me understand the stack faster while I build the tutorial. Can I pick this one up ? Thank You!

Of course! Thanks for your interest in GraphAr, feel free to reach out to us if you have any problem!

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

No branches or pull requests

4 participants