incubator-graphar icon indicating copy to clipboard operation
incubator-graphar copied to clipboard

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

Open lixueclaire opened this issue 1 year ago • 1 comments

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.

lixueclaire avatar May 24 '23 03:05 lixueclaire