Skip to content

Adding new docs link(s) to readme. Adding landing page for API refs #2228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cjnolet wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Adding new docs link(s) to readme. Adding landing page for API refs #2228

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
14a4b27
Update Fern and reorganize guide navigation
cjnolet Jun 2, 2026
8feffa0
Move integration patterns under field guide
cjnolet Jun 2, 2026
066d806
Update field guide docs
cjnolet Jun 2, 2026
6ff921e
Update fern/pages/advanced_topics.md
cjnolet Jun 2, 2026
729e9d2
Fix Fern API reference formatting
cjnolet Jun 2, 2026
55a0438
Set NVIDIA global Fern theme
cjnolet Jun 4, 2026
fc579bc
Updating README to point to new docs
cjnolet Jun 9, 2026
8dc29fc
Add API Reference landing page
cjnolet Jun 9, 2026
89fdd26
Merge docs updates into README branch
cjnolet Jun 9, 2026
1bd7776
Merge branch 'main' into readme-nvida-docs-link
cjnolet Jun 23, 2026
e9d4c55
Merge branch 'main' into readme-nvida-docs-link
cjnolet Jun 24, 2026
8b546f1
Merge remote-tracking branch 'rapidsai/main' into readme-nvida-docs-link
cjnolet Jun 25, 2026
07d9eaa
Merge remote-tracking branch 'cjnolet/readme-nvida-docs-link' into re…
cjnolet Jun 25, 2026
24bc426
Update cuVS repository URLs
cjnolet Jun 25, 2026
3b89c3c
Fix style after repository URL update
cjnolet Jun 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@

## Useful Resources

- [Documentation](https://docs.rapids.ai/api/cuvs/nightly/): Library documentation.
- [Build and Install Guide](https://docs.rapids.ai/api/cuvs/nightly/build): Instructions for installing and building cuVS.
- [Getting Started Guide](https://docs.rapids.ai/api/cuvs/nightly/getting_started): Guide to getting started with cuVS.
- [Documentation](https://docs.nvidia.com/cuvs): Library documentation.
- [Build and Install Guide](https://docs.nvidia.com/cuvs/installation): Instructions for installing and building cuVS.
- [Getting Started Guide](https://docs.nvidia.com/cuvs/getting-started): Guide to getting started with cuVS.
- [Code Examples](https://github.com/rapidsai/cuvs/tree/HEAD/examples): Self-contained Code Examples.
- [API Reference Documentation](https://docs.rapids.ai/api/cuvs/nightly/api_docs): API Documentation.
- [API Reference Documentation](https://docs.nvidia.com/cuvs/api_reference): API Documentation.
Comment on lines +15 to +19

@coderabbitai coderabbitai Bot Jun 9, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Find remaining references to old RAPIDS docs URLs

# Search for old docs.rapids.ai URLs across the codebase
rg -n 'docs\.rapids\.ai/api/cuvs' -g '!README.md'

Repository: rapidsai/cuvs

Length of output: 1629

🏁 Script executed:

#!/bin/bash
# Description: Find remaining references to any legacy RAPIDS docs domain

rg -n 'docs\.rapids\.ai' -g '!README.md'

Repository: rapidsai/cuvs

Length of output: 3874

Align remaining cuVS documentation URLs beyond README

README now links to docs.nvidia.com/cuvs, but the repo still contains legacy docs.rapids.ai/api/cuvs/... pointers (e.g., python/cuvs/pyproject.toml, python/libcuvs/pyproject.toml, fern/pages/index.md, and cuVS-related notebooks). This can lead to inconsistent doc navigation depending on entry point—either update these to docs.nvidia.com/cuvs or confirm the legacy links are intentionally kept/redirect.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 15 - 19, Search the repo for legacy
docs.rapids.ai/cuvs links and replace them with the canonical
docs.nvidia.com/cuvs endpoints (or confirm and annotate intentional redirects) —
specifically update the references found in python/cuvs/pyproject.toml,
python/libcuvs/pyproject.toml, fern/pages/index.md and any cuVS notebooks to use
https://docs.nvidia.com/cuvs (or the appropriate subpaths such as /api/cuvs,
/installation, /getting-started); if a legacy link must remain, add a brief
comment/NOTE in that file explaining it intentionally points to the legacy host.
Ensure URL scheme, host and path match the README style and run a repo-wide grep
for docs.rapids.ai to catch remaining instances.

- [RAPIDS Community](https://rapids.ai/community.html): Get help, contribute, and collaborate.
- [GitHub repository](https://github.com/rapidsai/cuvs): Download the cuVS source code.
- [Issue tracker](https://github.com/rapidsai/cuvs/issues): Report issues or request features.
Expand Down
1 change: 1 addition & 0 deletions fern/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,7 @@ navigation:
- page: "Contributing"
path: "./pages/contributing.md"
- section: "API Reference"
path: "./pages/api_reference.md"
contents:
- section: "C API Documentation"
path: "./pages/c_api/index.md"
Expand Down
18 changes: 18 additions & 0 deletions fern/pages/api_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
slug: api-reference
---

# API Reference

Use these generated references to inspect NVIDIA cuVS APIs by language. These pages are generated from the public source code and are best for checking signatures, parameters, return types, types, and language-specific API surfaces.

For task-focused examples and usage guidance, see the [API Guide](/user-guide/api-guides).

## Language References

- [C API Documentation](/api-reference/c-api-documentation): inspect the ABI-stable C API layer used by NVIDIA cuVS language bindings and downstream integrations.
- [C++ API Documentation](/api-reference/cpp-api-documentation): inspect the core NVIDIA cuVS C++ APIs, including common RAFT types used in public headers.
- [Python API Documentation](/api-reference/python-api-documentation): inspect Python modules, classes, functions, and parameters.
- [Java API Documentation](/api-reference/java-api-documentation): inspect Java classes, resources, matrices, indexes, and query APIs.
- [Rust API Documentation](/api-reference/rust-api-documentation): inspect Rust modules, structs, and wrappers around NVIDIA cuVS APIs.
- [Go API Documentation](/api-reference/go-api-documentation): inspect Go packages for supported NVIDIA cuVS APIs.
Loading