[DOC] Some doxygen groups are not found on doc (HNSW, CAGRA)
Open
Nobody has claimed this yet.
doc
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 62
Description
Report incorrect documentation
Location of incorrect documentation
- HNSW:
- On C++ the doxygen groups are not found: https://docs.rapids.ai/api/cuvs/nightly/cpp_api/neighbors_hnsw/
- CAGRA:
- On C++ the doxygen groups are not well divided (one
endgroupis missing so it breaks most things) https://docs.rapids.ai/api/cuvs/nightly/cpp_api/neighbors_cagra/
- On C++ the doxygen groups are not well divided (one
- C API: all the serialize groups for the ANN algorithms are not found:
Happens on Legacy, Stable and Nightly doc
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked HNSW and CAGRA C++ API pages and the C API serialize index pages; inspect the Doxygen group declarations for the missing or mispaired groups. Verify that HNSW, CAGRA, and ANN serialization groups render correctly across the Legacy, Stable, and Nightly documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100