[DISC] Improving Documentation

[bhavnicksm]

Hey there!

Thank you for your support of 🦛 Chonkie✨! I am extremely grateful to the community for the support and enthusiasm regarding Chonkie.

As you might be aware, the Chonkie documentation at the moment is a simple DOCS.md file, which works out just fine as it stands, but as we expand Chonkie's feature set and capabilities to handle complex tasks and make it even faster, it would soon become hard to manage.

Documentation for PyPI packages is generally pretty annoying and cumbersome. I hope to get something that's simple, straight-forward, and doesn't consume much time.

A test for a good source of documentation is that:

• It should not take more time to document a feature than it takes to code the feature
• Documentation inline is not fine if it makes the code look ugly and unreadible; I'd rather maintain a DOCS.md than an ugly codebase
• It should be open for easy contributions by community members (I'd be very happy to accept documentation PRs that make significant improvements in readability, btw)

I am currently looking at options for this, and I hope I could receive some advice from the community on how to expand and scale the documentation better.

Thanks!

[mrmps]

I recommend mintlify

[bhavnicksm]

I recommend mintlify

Looks like a good option! I will check it out...

Do you have experience with it @mrmps? Could I ask you some questions in case I have some issues?

[mrmps]

Yup! It's super easy to get started, you just keep all your data in Markdown files.

Mintlify's support is also extremely good, I had an issue and they responded pretty much immediately