Skip to content

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

Description

@kylebernhardy

Outcome

Provide the documentation developers expect from an independent open-source native library.

Acceptance criteria

  • README covers installation, native and Rocks usage, supported platforms, quick starts, lifecycle, errors, cancellation, and operational expectations.
  • API reference documents schemas, mutations, search modes, scores, pagination, highlighting, status, metrics, and close behavior.
  • Rocks guide documents caller ownership, compatible rocksdb-js versions, durability, backups, recovery, and generation cleanup.
  • Examples include standalone native, standalone rocksdb-js, multiple indexes, phrase/fuzzy/autocomplete, and graceful shutdown.
  • Performance methodology, benchmark history, semantic-versioning policy, security reporting, contribution instructions, and support matrix are linked.
  • Harper-specific schema and query documentation remains owned by Harper rather than duplicated here.

Comment generated by kAIle (Codex GPT-5)

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