Skip to content

#91 - Point README doc links at the live docs site#92

Merged
dleshchev merged 1 commit into
mainfrom
docs/readme-link-to-live-site
May 22, 2026
Merged

#91 - Point README doc links at the live docs site#92
dleshchev merged 1 commit into
mainfrom
docs/readme-link-to-live-site

Conversation

@dleshchev
Copy link
Copy Markdown
Collaborator

@dleshchev dleshchev commented May 22, 2026

Summary

  • Switch README Documentation, Tutorials, and the two inline "See [Getting Started]" links to their nvidia.github.io/daqiri/... URLs so readers land on the Material-rendered pages with search and nav.
  • Leave CONTRIBUTING.md and LICENSE as repo-relative — they aren't part of the docs site.

Closes #91.

Test plan

  • On the rendered README at github.com/NVIDIA/daqiri, click each of the 9 changed links and confirm they land on the corresponding page on nvidia.github.io/daqiri.
  • Confirm CONTRIBUTING.md and LICENSE links still resolve in-repo.

🤖 Generated with Claude Code

Replace docs/*.md links in the Documentation, Tutorials, and inline
"Getting Started" callouts with their nvidia.github.io/daqiri/
counterparts so README readers land on the MkDocs Material-rendered
pages (with search and nav) instead of raw markdown. CONTRIBUTING.md
and LICENSE stay repo-relative since they aren't part of the docs site.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Denis Leshchev <dleshchev@nvidia.com>
@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented May 22, 2026

Greptile Summary

This PR updates README.md to point its Documentation, Tutorials, and two inline "Getting Started" callout links from repo-relative docs/*.md paths to the corresponding nvidia.github.io/daqiri/ URLs, so readers on GitHub land on the MkDocs Material-rendered pages with search and navigation. CONTRIBUTING.md and LICENSE are intentionally left as repo-relative links.

  • Nine links in the Documentation and Tutorials sections are changed to their live-site equivalents; all URLs match the nav: structure in mkdocs.yml.
  • CONTRIBUTING.md and LICENSE references are unchanged, consistent with the PR description.

Confidence Score: 5/5

Safe to merge — only README link targets change, no code or build logic is touched.

All nine updated URLs map correctly to the MkDocs nav entries in mkdocs.yml, the commit carries a valid DCO sign-off and correctly formatted title, and CONTRIBUTING.md / LICENSE remain repo-relative as intended.

No files require special attention.

Important Files Changed

Filename Overview
README.md Nine doc links updated from repo-relative paths to live nvidia.github.io/daqiri/ URLs; all match mkdocs.yml nav structure. No functional or content changes.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md link] --> B{Link type}
    B -->|Doc/Tutorial| C[nvidia.github.io/daqiri/...]
    B -->|Repo file| D[CONTRIBUTING.md / LICENSE]
    C --> E[MkDocs Material site with search & nav]
    D --> F[Raw GitHub repo view]
Loading

Reviews (1): Last reviewed commit: "#91 - Point README doc links at the live..." | Re-trigger Greptile

@dleshchev dleshchev merged commit 35f2278 into main May 22, 2026
3 checks passed
@dleshchev dleshchev deleted the docs/readme-link-to-live-site branch May 22, 2026 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] README links point to raw .md files instead of the live docs site

1 participant