docs: update README with all missing features and API documentation (closes #65)#168
Merged
Merged
Conversation
…loses #65) - Add complete API Reference sections: ZVecIndexParams, ZVecCollectionOptions, ZVecFieldSchema, ZVecCollectionStats, ZVecVectorQuery, re-rankers, reranked docs - Add Data Types table with 28 type constants, values, and PHP types - Add Index Types, Metric Types, and Quantize Types reference tables - Update ZVec (Collection) section with all lifecycle, schema ops, index management, batch operations, and search variants - Update ZVecSchema section with all 24+ add* methods - Update ZVecDoc section with all setters/getters/introspection/serialization - Update Known Limitations with alterColumn, GroupByVectorQuery, queryById constraints - Expand README from 370 to 891 lines
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Closes #65
Complete rewrite and expansion of the README with all missing API documentation sections. The README now covers every public method across all classes and includes comprehensive reference tables for data types, index types, metrics, and quantization.
Changes
Added new sections
Updated existing sections
Stats
Testing
Code Review