[BUG]: Documentation and tutorial fixes: broken reference link in cuda-cpp contributing guide and typo in Ozaki-I notebook

Open Beginner friendly
  • Is something wrong?
#294 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 4 days

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
cpp, jupyter-notebook
Domain
documentation

Research direction

Start in tutorials/cuda-cpp/CONTRIBUTING.md: fix the relative link on line 325 so it points to notebooks/01.02-Execution-Spaces/Solutions/no-magic-execution-space-changes.cpp, and correct "starts" to "start" on line 14. Then open tutorials/floating-point-emulation/notebooks/03-Ozaki-I-Emulation/03.01-UnfusedEmulation.ipynb, change "refering" to "referring" in markdown cell 1, and check that the link resolves. Done when both files are corrected and the link no longer 404s.

Written by the indexing model from the issue text.

Description

bug
Is this a duplicate?
Describe the bug
  1. In tutorials/cuda-cpp/CONTRIBUTING.md line 325, the link [here](Solutions/no-magic-execution-space-changes.cpp) points to a non-existent relative path. The actual solution file is located at notebooks/01.02-Execution-Spaces/Solutions/no-magic-execution-space-changes.cpp. Additionally, line 14 has a subject-verb agreement mismatch (Traditional CUDA courses typically starts with... instead of start with).
  2. In tutorials/floating-point-emulation/notebooks/03-Ozaki-I-Emulation/03.01-UnfusedEmulation.ipynb markdown cell 1, "referring" is misspelled as "refering".
Steps to reproduce
  1. Navigate to tutorials/cuda-cpp/CONTRIBUTING.md and click the link on line 325 ([here](Solutions/no-magic-execution-space-changes.cpp)). It returns a 404 / file not found error.
  2. Open tutorials/floating-point-emulation/notebooks/03-Ozaki-I-Emulation/03.01-UnfusedEmulation.ipynb and view markdown cell 1.
Expected behavior
  1. The link in tutorials/cuda-cpp/CONTRIBUTING.md should resolve directly to notebooks/01.02-Execution-Spaces/Solutions/no-magic-execution-space-changes.cpp.
  2. Typos and grammar errors should be corrected.
Actual behavior
  1. The link leads to a missing target (tutorials/cuda-cpp/Solutions/no-magic-execution-space-changes.cpp).
  2. "refering" is used instead of "referring", and "courses ... starts" instead of "courses ... start".
Environment

All platforms (Documentation / Jupyter Notebook)

Additional context

I have a patch ready and will submit a PR linking to this issue.

Dominant language
Jupyter Notebook
Stars
2.1k
Forks
358
Avg merge
3d 19h
Merged PRs (30d)
9

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from NVIDIA/accelerated-computing-hub

All issues in NVIDIA/accelerated-computing-hub

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.