Skip to content

Add Chonkie Integration Information to Chroma Docs #4619

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

shreyash-chonkie
Copy link

Description of changes

Hi Chroma team,

I'm the maintainer of Chonkie, an open-source library for chunking and embedding data. We've recently added a "Chroma Handshake" to our library, which embeds and writes chunks to a Chroma collection.

This PR updates the integration documentation to include details on how users can chunk data with Chonkie and use the Chroma Handshake to store those chunks.

  • Improvements & Bug fixes
    • N/A
  • New functionality
    • Adds chonkie integration docs

Test plan

How are these changes tested?

  • N/A (I did run grammar check though)

Documentation Changes

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

Please let me know if any edits are required. Thanks!

Copy link
Contributor

propel-code-bot bot commented May 23, 2025

This PR updates the Chroma documentation by introducing detailed integration instructions for the Chonkie open-source library. It adds a new Chonkie integration guide in the frameworks section and lists Chonkie in the integrations overview table, providing installation, usage, and quickstart examples for using Chonkie and its Chroma Handshake to chunk, embed, and store data in Chroma collections.

This summary was automatically generated by @propel-code-bot

Copy link

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)

…tegrations.md

Co-authored-by: propel-code-bot[bot] <203372662+propel-code-bot[bot]@users.noreply.github.com>
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.

1 participant