This PR adds makes various improvements around the crate documentation.
It is quite big, and I don't expect others to go through it line by line. It does not have code/logic changes. Examples are sourced from our test snippets.
As always, inspect these changes locally with: cargo doc --no-deps --open
It adds a basic connection example (and adds a Qdrant logo):
It adds basic operation documentation, a minimal example and links to our main documentation:
It hides deprecated modules:
Amongst other things.
All Submissions:
[x] Contributions should target the dev branch. Did you create your branch from dev?
[x] Have you followed the guidelines in our Contributing document?
[x] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
New Feature Submissions:
[x] Does your submission pass tests?
[x] Have you formatted your code locally using cargo +nightly fmt --all command prior to submission?
[x] Have you checked your code using cargo clippy --all --all-features command?
This PR adds makes various improvements around the crate documentation.
It is quite big, and I don't expect others to go through it line by line. It does not have code/logic changes. Examples are sourced from our test snippets.
As always, inspect these changes locally with:
cargo doc --no-deps --openIt adds a basic connection example (and adds a Qdrant logo):
It adds basic operation documentation, a minimal example and links to our main documentation:
It hides deprecated modules:
Amongst other things.
All Submissions:
devbranch. Did you create your branch fromdev?New Feature Submissions:
cargo +nightly fmt --allcommand prior to submission?cargo clippy --all --all-featurescommand?