search

jbellis / jvector

JVector: the most advanced embedded vector search engine
Apache License 2.0
1.51k stars 112 forks source link

General documentation and API index #114

Open bahmanm opened 1 year ago

bahmanm commented 1 year ago

First off, great work!

It'd be very helpful if there were general documentation which helped map the theory and concepts to the class hierarchy or the main facades.

That may be augmented w/ potentially more examples and definitely an API index to browse.

jbellis commented 5 months ago

Does the new README help?

rd-99 commented 5 months ago

First off, great work!

It'd be very helpful if there were general documentation which helped map the theory and concepts to the class hierarchy or the main facades.

That may be augmented w/ potentially more examples and definitely an API index to browse.

https://speakerdeck.com/michaelisvy/spring-petclinic-sample-application - Iam guessing something like this, but for a large project it will need multiple contributors(will also help in long-term for oss contributers)

bahmanm commented 4 months ago

Does the new README help?

It certainly is way better. I also love the examples sub-project.