Skip to content

docs: fix stale sample README links flagged by lychee - #3076

Closed
lijinf2 wants to merge 1 commit into
NVIDIA:mainfrom
lijinf2:fix/lychee-sample-readme-links
Closed

lijinf2 wants to merge 1 commit into
NVIDIA:mainfrom
lijinf2:fix/lychee-sample-readme-links

Conversation

@lijinf2

@lijinf2 lijinf2 commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes the 7 broken links reported by the lychee documentation link-checker across samples/ READMEs (moved/renamed upstream pages for libcudacxx, cuda.compute, Nsight Compute occupancy calculator, RAPIDS install docs, and the cuda-samples repo layout).

File Old (404) New
samples/cuda_bindings/3_CUDA_Features/globalToShmemAsyncCopy/README.md nvidia.github.io/libcudacxx/.../memcpy_async.html nvidia.github.io/cccl/unstable/libcudacxx/.../memcpy_async.html
samples/cuda_bindings/3_CUDA_Features/globalToShmemAsyncCopy/README.md nvidia.github.io/libcudacxx/.../pipeline.html nvidia.github.io/cccl/unstable/libcudacxx/.../pipeline.html
samples/cuda_core/binarySearch/README.md nvidia.github.io/cccl/python.html nvidia.github.io/cccl/unstable/python/compute/index.html
samples/cuda_core/cudaComputeLambdas/README.md nvidia.github.io/cccl/python.html nvidia.github.io/cccl/unstable/python/compute/index.html
samples/cuda_core/launchConfigTuning/README.md docs.nvidia.com/cuda/cuda-occupancy-calculator/ docs.nvidia.com/nsight-compute/.../occupancy-calculator
samples/cuda_core/pageRank/README.md rapids.ai/start.html docs.nvidia.com/datascience/install/
samples/cuda_core/simplePrint/README.md cuda-samples/.../Samples/0_Introduction/simplePrintf cuda-samples/.../cpp/0_Introduction/simplePrintf
samples/cuda_core/tmaTensorMap/README.md nvidia.github.io/cccl/libcudacxx/.../barrier.html nvidia.github.io/cccl/unstable/libcudacxx/.../barrier.html

Verification

Ran lychee (v0.24.2, matching the pinned pre-commit hook) against all 7 touched files before and after:

  • Before: 8 [404] Rejected status code: 404 Not Found errors across the 7 files.
  • After: 0 errors (35/35 links OK, 1 redirect noted).

Notes

  • This is a small, standalone cherry-pick of the docs-only commit from the in-flight rwgk/maint/lychee-pr-nightly branch (draft ci: complete pre-commit.ci replacement and cache Lychee checks #2993), since that branch bundles a much larger CI/lychee workflow overhaul that isn't ready to merge yet. Pulling just the link fixes out lets main stop reporting these 7 real errors without waiting on the full CI rework.
  • Unrelated to this PR: locally, the lychee pre-commit hook currently also flags 7 different, pre-existing errors — 503 Service Unavailable on github.com/NVIDIA/cuda-python/blob/... links (CONTRIBUTING.md and test_memory_ipc.py) — when run without a GITHUB_TOKEN. These are anonymous-rate-limit false positives (CI passes because lychee-action is given token: ${{ github.token }}); they're not addressed here and aren't caused by this change.

@copy-pr-bot

copy-pr-bot Bot commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

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.

@github-actions github-actions Bot added cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module labels Oct 12, 2026
@coderabbitai

coderabbitai Bot commented Oct 12, 2026

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: NVIDIA/cuda-python/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Enterprise
  • Run ID: bb492da1-8ed5-4a4e-b63e-5fcfe48ef4fa

📥 Commits

Reviewing files that changed from the base of the PR and between c7e6f09 and e8b0edf.


📒 Files selected for processing (7)
  • samples/cuda_bindings/3_CUDA_Features/globalToShmemAsyncCopy/README.md
  • samples/cuda_core/binarySearch/README.md
  • samples/cuda_core/cudaComputeLambdas/README.md
  • samples/cuda_core/launchConfigTuning/README.md
  • samples/cuda_core/pageRank/README.md
  • samples/cuda_core/simplePrint/README.md
  • samples/cuda_core/tmaTensorMap/README.md

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.



📝 Summary

Summary by CodeRabbit

  • Documentation
    • Updated links across CUDA samples to point to current library references, installation guides, occupancy tools, and sample locations.

Walkthrough

Seven sample README files update links to CUDA documentation, the Nsight Compute Occupancy Calculator, NVIDIA Data Science installation documentation, and a C++ sample.

Changes

Sample README links

Layer / File(s) Summary
Update sample README link targets
samples/cuda_bindings/3_CUDA_Features/globalToShmemAsyncCopy/README.md, samples/cuda_core/binarySearch/README.md, samples/cuda_core/cudaComputeLambdas/README.md, samples/cuda_core/launchConfigTuning/README.md, samples/cuda_core/pageRank/README.md, samples/cuda_core/simplePrint/README.md, samples/cuda_core/tmaTensorMap/README.md
Updates links for cuda::memcpy_async, cuda::pipeline, cuda.compute, cuda::barrier, the occupancy calculator, RAPIDS installation, and the simplePrintf sample.

Suggested reviewers: danielfrg


Priority: ⬇️ Low

Change: Other

Merge Risk: ⚪ Minimal · up to e8b0e

The changes are limited to sample documentation links, with no merge-blocking issue established in the supplied context. The reported link check found no remaining errors.

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Commit to this branch
  • Create a new PR

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Comment @coderabbitai help to get the list of available commands.

@lijinf2 lijinf2 closed this Oct 12, 2026
@lijinf2
lijinf2 deleted the fix/lychee-sample-readme-links branch October 12, 2026 07:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cuda.bindings Everything related to the cuda.bindings module cuda.core Everything related to the cuda.core module

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants