Skip to content

[DOC] Add cuvs-lucene documentation to cuVS docs #2289

Description

@cjnolet

We currently generate Java API reference docs for cuvs-java, but not for cuvs-lucene. This is mostly because cuvs-lucene is a separate repository today, however we plan to move cuvs-lucene into cuvs in the upcoming (26.10) release. We will need to make sure the docs include API guides for cuvs-lucene (in the User Guide), that we update the integrations page to point to the moved cuvs-lucene in cuvs/java/cuvs-lucene, and that we host the generated Fern javadocs inside the Java API reference. This will also mean we need to create a landing page for the Java API reference and have it branch off into cuvs-java and cuvs-lucene (at the moment cuvs only contains cuvs-java, so the Java API Reference just assumes cuvs-java docs).

Metadata

Metadata

Assignees

No one assigned

    Labels

    docImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    Todo
    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions