Skip to content

docs: update README with all missing features and API documentation (closes #65)#168

Merged
s2x merged 1 commit into
mainfrom
docs/issue-65-update-readme-missing-features
Jul 8, 2026
Merged

docs: update README with all missing features and API documentation (closes #65)#168
s2x merged 1 commit into
mainfrom
docs/issue-65-update-readme-missing-features

Conversation

@s2x

@s2x s2x commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

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

  • ZVecIndexParams — all 6 factory methods (forHnsw, forHnswRabitq, forFlat, forIvf, forVamana, forInvert)
  • ZVecCollectionOptions — constructor, readOnly/readWrite/defaults factory methods
  • ZVecFieldSchema — all 12 getter methods for field introspection
  • ZVecCollectionStats — doc count, index count, completeness APIs
  • ZVecVectorQuery — all 12 fluent setters + fromId()
  • ZVecGroupByVectorQuery — constructor, setters, unsupported methods doc
  • ZVecReRanker (Interface) — interface definition
  • ZVecRrfReRanker — RRF formula, getters/setters
  • ZVecWeightedReRanker — weighted fusion, all getters/setters
  • ZVecRerankedDoc — combined score, source ranks/scores
  • Data Types — complete 28-row table with constants, values, PHP types
  • Index Types — 6 index type constants with descriptions
  • Metric Types — 4 metric constants
  • Quantize Types — 5 quantize constants

Updated existing sections

  • ZVec (Collection) — lifecycle (init/isInitialized/shutdown/version API), schema operations (8 addColumn* + alterColumn), index management (createIndex with ZVecIndexParams), batch operations (insertBatch/upsertBatch/updateBatch), all search variants (queryVector/queryFp16/queryFp64/queryMulti/queryByFilter/queryById/queryWithReranker/groupByVectorQuery)
  • ZVecSchema — all 24+ add* methods (scalar, dense vector, sparse vector, binary, array types + deprecated aliases)
  • ZVecDoc — all setters, getters, introspection, serialization, operator tracking, memory usage
  • Known Limitations — added alterColumn(), GroupByVectorQuery, queryById() constraints

Stats

  • README expanded from 370 → 891 lines (+521 lines)
  • All PHP code examples verified syntactically valid

Testing

  • All .phpt tests pass (pre-existing failures from native extension loading are unrelated)
  • No test database leftovers
  • Quick Start code example verified syntactically valid PHP

Code Review

  • Passed subagent code review
  • All review comments addressed

…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
@s2x s2x self-assigned this Jul 8, 2026
@s2x
s2x merged commit ce5b57a into main Jul 8, 2026
3 checks passed
@s2x
s2x deleted the docs/issue-65-update-readme-missing-features branch July 8, 2026 13:05
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.

DOC-006: Missing Features Not in README

1 participant