Better documentation
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 415
- Forks
- 83
- Avg merge
- 2h 20m
- Merged PRs (30d)
- 3
Description
I am a Rust user and I am becoming a qdrant fan. I want to use qdrant in a production project with Rust. Unfortunately I miss a beter documentation where not only examples but possibilities and how to use types are covered.
Wich are the available features of the crate, what does each function does, what each type does and how to create them from other common types like vectors and serde_json::Value, these are just some examples of questions that could be answered in a beter documentation.
I would like to help with that, but I will need the help of the developers to create that.
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
No files, tests, or entry points are named. Start by reviewing the Rust crate's public features, functions, types, and conversions from vectors and serde_json::Value, then coordinate with the developers on scope. Done means the available capabilities and usage of the public API are documented beyond examples.
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
- Needs clarification
- Newbie friendliness
- 25/100