[DOC] Follow up reviews to Fern conversion
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Domain
- documentation
Research direction
Start by comparing fern/pages/index.md with fern/pages/introduction.md, focusing on the two cuVS descriptions and the listed core concepts. Check the surrounding terminology and release context, then make the two entry points consistent about vector search, vector compression, and nearest neighbors; the terminology should be unambiguous in both places.
Written by the indexing model from the issue text.
Description
Report bothersome documentation
This is not incorrect, but it bothers me. In the new Fern docs index page fern/pages/index.md
NVIDIA cuVS is a GPU-accelerated library for nearest neighbors, vector compression, and clustering. It provides both core building blocks for constructing new algorithms and end-to-end algorithms that can be used directly or through a growing list of integrations.
NVIDIA cuVS contains state-of-the-art implementations of several algorithms for running approximate and exact nearest neighbors, vector compression, and clustering on the GPU.
I think we should replace 'vector compression' with 'vector search' in both places. Vector compression may be a building block of vector search, but the brand is 'cuVS' not 'cuVC' and so 'vector search' should be right at the starting point where users engage with the docs. If 'vector compression' is seen as an important building block, then I'm fine with it being in the list, but I think 'vector search' should be primary.
If we compare with the list of concepts in fern/pages/introduction.md we see
- Vector Search
- Clustering
- Vector Compression
- Vector Database
- Tuning Indexes
It'd be good if these two places (index and introduction) were rationalized with each other.
Perhaps there's some tension or confusion between whether to use nearest neighbor search or vector search as the primary concept? I see 'nearest neighbors' in the current index page in the two text blocks I pointed out above, but not listed as one of the core concepts in the introduction page.
I'll continue reviewing docs from the recent updates in this issue, but ideally this first concern could be addressed before 26.06 release because it is right at two user entry points for the docs.
To summarize:
- Please add 'vector search' to the two text blocks noted above in index.md, perhaps keeping 'vector compression' as well
- Should we mention 'nearest neighbors' in the introduction.md page?
- Dominant language
- Cuda
- Stars
- 854
- Forks
- 236
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 64
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.
More from NVIDIA/cuvs
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
ci Lucene
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agilepathway/label-checker#640 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
BasedHardware/omi#15662 · 1 comment ·
-
documentation help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
amponce/archive-movie-browser#167 ·
-
user-reported
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Kong/developer.konghq.com#7316 ·