Skip to content

Update tutorial readme to focus on quickstart example under the same …#1802

Closed
arhamm1 wants to merge 2 commits into
mainfrom
arhamm1-patch-16
Closed

Update tutorial readme to focus on quickstart example under the same …#1802
arhamm1 wants to merge 2 commits into
mainfrom
arhamm1-patch-16

Conversation

@arhamm1

@arhamm1 arhamm1 commented Apr 13, 2026

Copy link
Copy Markdown
Contributor

…heading

Removed link to the Getting Started Guide (dead link since it does not cover any concepts) in favor of quickstart example.

Description

Usage

# Add snippet demonstrating usage

Checklist

  • I am familiar with the Contributing Guide.
  • New or Existing tests cover these changes.
  • The documentation is up to date with these changes.

…heading

Removed link to the Getting Started Guide (dead link since it does not cover any concepts) in favor of quickstart example.

Signed-off-by: Arham Mehta <141266146+arhamm1@users.noreply.github.com>
@arhamm1 arhamm1 requested a review from lbliii April 13, 2026 20:23
@arhamm1 arhamm1 requested a review from a team as a code owner April 13, 2026 20:23
@arhamm1 arhamm1 requested review from weijiac0619 and removed request for a team April 13, 2026 20:23
@greptile-apps

greptile-apps Bot commented Apr 13, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Removes a dead link to the Getting Started Guide from the tutorials README, leaving only the reference to the quickstart.py example in the Quick Start section.

  • The line previously offered two options ("Start with the Getting Started Guide or try quickstart.py"); now it points directly to quickstart.py since the guide URL was broken.
  • No code logic is affected; this is a purely editorial change to documentation.

Confidence Score: 5/5

Safe to merge — removes a single dead external link, no functional code is touched.

The change is a one-line documentation edit that drops a broken URL and leaves the rest of the README intact. There is nothing that could regress.

No files require special attention.

Important Files Changed

Filename Overview
tutorials/README.md Single-line edit removes the dead Getting Started Guide link and keeps the quickstart.py reference; no other content changed.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[New to NeMo Curator?] --> B{Before PR}
    A --> C{After PR}
    B --> D[Getting Started Guide\n docs.nvidia.com — dead link]
    B --> E[quickstart.py]
    C --> F[quickstart.py]
    D -->|broken| G[404 / No content]
    E --> H[Core concepts example]
    F --> H
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[New to NeMo Curator?] --> B{Before PR}
    A --> C{After PR}
    B --> D[Getting Started Guide\n docs.nvidia.com — dead link]
    B --> E[quickstart.py]
    C --> F[quickstart.py]
    D -->|broken| G[404 / No content]
    E --> H[Core concepts example]
    F --> H
Loading

Reviews (2): Last reviewed commit: "Merge branch 'main' into arhamm1-patch-1..." | Re-trigger Greptile

@lbliii

lbliii commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Superseded by #2097, which keeps the intent of this change but adds a proper onboarding sequence (docs → Core Concepts → quickstart.py) instead of quickstart-only.

@lbliii

lbliii commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Closing in favor of #2097.

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.

3 participants