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

[cjnolet]

No description provided.

[copy-pr-bot]

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Updated all resource and reference links throughout the documentation to point to NVIDIA's official cuVS documentation site, replacing previous API and nightly documentation references
  • Added a comprehensive API Reference landing page providing centralized access to language-specific API documentation for C, C++, Python, Java, Rust, and Go, plus the API implementation guide

Walkthrough

The PR updates API reference documentation by replacing RAPIDS-hosted API links in README.md with direct references to the NVIDIA cuVS documentation site, and introduces a new Fern-based API reference landing page that aggregates language-specific NVIDIA API documentation links with corresponding navigation configuration.

Changes

API Reference Documentation Updates

Layer / File(s)	Summary
README documentation links update README.md	The "Useful Resources" section replaces RAPIDS API documentation URLs (docs.rapids.ai/api/cuvs/nightly/...) with direct NVIDIA cuVS documentation links (docs.nvidia.com/cuvs/...) for Documentation, Build and Install Guide, Getting Started Guide, Code Examples, and API Reference Documentation.
API reference landing page and navigation fern/docs.yml, fern/pages/api_reference.md	A new API reference landing page with YAML frontmatter (slug: api-reference) and language-specific NVIDIA cuVS API documentation links (C, C++, Python, Java, Rust, Go) is created and wired into the Fern documentation navigation via an updated path entry in the "API Reference" section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• rapidsai/cuvs#2030: Both PRs modify the Fern documentation infrastructure (fern/docs.yml and related documentation pages), so these changes are part of the same docs-navigation and content management updates.

Suggested labels

doc, non-breaking

Suggested reviewers

• dantegd

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to assess whether the description relates to the changeset.	Provide a description explaining the purpose of updating documentation links and adding the API reference landing page for future reference.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main changes: updating README documentation links and adding a new API reference landing page.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with 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.

Inline comments:
In `@README.md`:
- Around line 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.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: f6b0b997-27e9-4016-bcc9-325be5dde02b

📥 Commits

Reviewing files that changed from the base of the PR and between 78135be and 89fdd26.

📒 Files selected for processing (3)

• README.md
• fern/docs.yml
• fern/pages/api_reference.md

[coderabbitai]

⚠️ 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.

[cjnolet]

/ok to test 89fdd26