-
Notifications
You must be signed in to change notification settings - Fork 85
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Describe the enhancement requested
This issue proposes to establish comprehensive documentation for the Rust bindings, referring to the precedent of the Python documentation efforts (see issue #802 and @apache/incubator-graphar-website/issues/55).
The following tasks are included:
-
Rust Usage Documentation
- Create user-facing documentation for Rust usage at
/docs/libraries/rust/. - Document installation, basic usage, and code examples to help users get started with the Rust interface.
- Create user-facing documentation for Rust usage at
-
Rust API Documentation
- Setup automated generation of Rust API documentation as part of the CI workflow.
- Ensure the API docs are kept up-to-date and published alongside other language APIs if applicable.
-
Rust Implementation Status
- Add and maintain a Rust implementation status document at
docs/specification/implementation-status.md. - Clearly outline which parts of the GraphAr spec are supported, in progress, or planned for Rust.
- Add and maintain a Rust implementation status document at
Component(s)
Rust
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request