feat(docs): Add comprehensive Rust documentation for core modules#170
Merged
sonam-pankaj95 merged 1 commit intoSep 22, 2025
Merged
Conversation
- Add module-level documentation for file_processor, models, chunkers, embeddings, and reranker modules - Document Dtype enum with precise type descriptions - Document FileLoadingError enum for error handling - Update function examples to use current EmbedderBuilder API - Add documentation for audio processing, cloud embeddings, and multimodal models Resolves StarlightSearch#88 EOF
dunky-star
force-pushed
the
feature/rust-documentation
branch
from
4632b83 to
469c219
Compare
sonam-pankaj95
approved these changes
Sep 22, 2025
sonam-pankaj95
left a comment
sonam-pankaj95
left a comment
Collaborator
There was a problem hiding this comment.
Looks good, Thanks for your contributions!!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses Issue #88 by adding comprehensive documentation for all major Rust modules that were previously undocumented.
Resolves #88
Please review