Rust documentation is currently very poor
Open
Nobody has claimed this yet.
Documentation
- Dominant language
- Rust
- Stars
- 642
- Forks
- 70
- Avg merge
- 2d 13h
- Merged PRs (30d)
- 21
Description
The main text of the rust docs comes from raphtory/src/lib.rs which is a rough copy of the readme.
We should:
- Update the readme
- Add syncing the readme to lib.rs comment as part of the CI cleanup tasks
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the repository README and raphtory/src/lib.rs, which currently supplies the docs.rs text. Inspect the CI cleanup configuration to determine where README-to-lib.rs synchronization belongs. Done means the README is improved and the Rust library documentation stays synchronized with it automatically.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- ci-cd, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100