chonkie was just fine with a single DOCS.md! do we have to do this? UGH
Chonkie was built with the principle of being so simple that the documentation would be minimal. However, as we grow, we need to add more documentation to help users understand the different chunking strategies available to them. So here we are!
Warning
These docs have been archieved and are no longer updated! The docs have been moved to the chonkie repository in order to keep a tighter connection between the codebase and the docs.
If you find any incorrect documentation, please open an issue or submit a PR to fix it. You can:
- Open an issue describing the problem
- Edit the docs directly and submit a pull request
- Use the "Suggest an edit" button at the bottom of any documentation page
For pull requests, please:
- Clearly describe what you're fixing
- Reference any related issues
- Follow the existing documentation style
- Test any code examples you modify
We appreciate your help in keeping our documentation accurate and up-to-date!