Skip to content

[DOC] Stale API Docs #2546

Description

@imotov

Report incorrect documentation

The cuVS API reference pages under fern/pages/*_api/ are generated by fern/scripts/generate_api_reference.py, but in practice it is rarely run. To make things worse, individual generated pages get hand-edited (or maybe agent-edited), and CI can't catch the resulting drift because fern/build_docs.sh regenerates before running fern check, so it always validates freshly-generated output rather than what's committed.

I just ran the generator, and noticed that it touched 61 pages, adding 102 symbols that had never been documented and removing 33 that no longer exist in the source. At the moment the docs had drifted roughly five weeks.

Activity

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

Metadata

Metadata

Assignees

Labels

docImprovements or additions to documentation

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions