Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Update documentation for Haystack integration #3112

Conversation

Yugsolanki
Copy link

@Yugsolanki Yugsolanki commented Nov 9, 2024

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • Updated the Haystack integration documentation for better clarity and accuracy.
  • New functionality
    • Added examples for using ChromaDocumentStore with Haystack.

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

Are all docstrings for user-facing APIs updated if required? Do we need to make documentation changes in the docs repository?

  • Updated the Haystack integration documentation in the current repository. No changes needed in the docs repository.

This pull request closes #3111 .

Copy link

github-actions bot commented Nov 9, 2024

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@itaismith
Copy link
Contributor

Hey @Yugsolanki! Do you mind re-submitting this PR and modifying the title to begin with [DOC] (instead of DOC:). This makes our CI checks fail. See https://docs.trychroma.com/contributing. Thank you!

@itaismith itaismith closed this Dec 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc]: Update Haystack Integration Documentation
2 participants