Skip to content

Docs improvements#1992

Open
aamijar wants to merge 6 commits intorapidsai:mainfrom
aamijar:docs-improvements
Open

Docs improvements#1992
aamijar wants to merge 6 commits intorapidsai:mainfrom
aamijar:docs-improvements

Conversation

@aamijar
Copy link
Copy Markdown
Member

@aamijar aamijar commented Apr 6, 2026

Continued overhaul of cuvs docs:

  1. Separate Multi-GPU Nearest Neighbors docs into top level section with subpages.
  2. Add docs for Multi-GPU All-Neighbors
  3. Add Spectral Clustering and Spectral Embedding Python API docs (refer to cuml)
  4. Add NN-Descent to C API docs
  5. Change Bruteforce title to Brute Force KNN
  6. Fix overload grouping on right sidebar
  7. Fix doc treedepth
  8. Separate Quantizer docs into subpages for each type
  9. Various spelling, capitalization, and alphabetical ordering fixes.
  10. Remove non-ascii characters (such as smart apostrophe)
  11. Fix broken links

How to build docs locally

cd /home/coder/cuvs/cpp/doxygen && doxygen Doxyfile
cd /home/coder/cuvs/docs && make html
cd /home/coder/cuvs/docs/build/html && python -m http.server 8080

@aamijar aamijar requested review from a team as code owners April 6, 2026 17:04
@aamijar aamijar self-assigned this Apr 6, 2026
@aamijar aamijar added non-breaking Introduces a non-breaking change doc Improvements or additions to documentation labels Apr 6, 2026
@aamijar aamijar moved this to In Progress in Unstructured Data Processing Apr 6, 2026
cpp_api/cluster.rst
cpp_api/distance.rst
cpp_api/neighbors.rst
cpp_api/neighbors_mg.rst
Copy link
Copy Markdown
Member

@cjnolet cjnolet Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see- you put these out in the top-level for the C++ itself. Hmm. That's not awful. I think it's easier for users to find it this way. I think this is okay. When you said top-leve, I thought you measnt the top level index of the docs themselves.

I still wonder though- would this be better placed inside of the neighbors index? It seems like it'd make more sense there, rather than having it parallel to the other namespaces.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I was thinking it would be easier to find for users to have it moved up. But we can keep it in neighbors if you prefer.

python_api/cluster.rst
python_api/distance.rst
python_api/neighbors.rst
python_api/neighbors_multi_gpu.rst
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I'd prefer if this was nested inside "neighbors".

@@ -1,5 +1,6 @@
document.addEventListener("DOMContentLoaded", () => {
const toc = document.querySelector(".bd-toc-nav");
const toc = document.querySelector("#pst-page-toc-nav") ||
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you briefly describe what this change does?

Copy link
Copy Markdown
Member Author

@aamijar aamijar Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is to fix point 6. Fix overload grouping on right sidebar.
For example instead of showing build a bunch of times, it shows build once. This used to work before without the change, but maybe there was some dependency update that made it stop working.
Ref: #1377

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

Labels

doc Improvements or additions to documentation non-breaking Introduces a non-breaking change

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

2 participants