Skip to content

Write the README, API reference, storage guide, examples, and support policy #6

Description

@kylebernhardy

Outcome

Document the library as a supported native Tantivy backend plus a qualified Harper integration, with explicit implementation status.

Acceptance criteria

  • README covers installation, native quick start and Harper setup, supported platforms/versions, lifecycle and errors.
  • Document schemas, search modes, scores, pagination, highlighting, limits, status and metrics.
  • Explain Harper storage ownership, bounded transport, durable publication versus searchable visibility, replay, backup/restore, shutdown and troubleshooting.
  • State that Harper stores index state only in RocksDB, owns its storage dependency version, and has no native-file fallback.
  • No public standalone rocksdb-js guide, /rocks factory, optional peer or native lease contract is advertised.
  • Test public examples against packed packages and qualified Harper versions.
  • Document reproducible native/Harper benchmarks, measurement scopes, GitHub release comparisons, support/security policy and Apache-2.0 licensing.

Design

Tantivy storage through Harper. The Harper integration is planned; the native backend is implemented. No production change to base rocksdb-js is required by this work.

Comment generated by kAIle (GPT-6)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

area:apiPublic Node.js and native APIarea:documentationREADME, API reference, examples, and design documentationdocumentationImprovements or additions to documentation

Type

Fields

Priority

P3

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions