apache / apache/incubator-graphar

feat(rust): build Rust documentation

Open
#816 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
373
Forks
93
Avg merge
7d 21h
Merged PRs (30d)
7

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](https://github.com/apache/incubator-graphar-website/issues/55)).

The following tasks are included:

1. **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.

2. **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.

3. **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.

### Component(s)

Rust

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Python documentation precedent in issue #802 and the linked website issue. Then organize the work around /docs/libraries/rust/ and docs/specification/implementation-status.md, and inspect the existing CI workflow for API documentation generation. Done means Rust usage and API documentation are published or automated as appropriate, with implementation status recorded.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.