Skip to content

docs: expand tutorials Quick Start with docs and Core Concepts links#2097

Open
lbliii wants to merge 2 commits into
NVIDIA-NeMo:mainfrom
lbliii:lbliii/tutorials-readme-onboarding
Open

docs: expand tutorials Quick Start with docs and Core Concepts links#2097
lbliii wants to merge 2 commits into
NVIDIA-NeMo:mainfrom
lbliii:lbliii/tutorials-readme-onboarding

Conversation

@lbliii

@lbliii lbliii commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Summary

Builds on #1802 with a content-strategy fix for the tutorials README Quick Start section.

  • Removes the mislabeled Getting Started link (it pointed to install/modality quickstarts, not core concepts)
  • Adds a clear onboarding sequence: documentationCore Conceptsquickstart.py
  • Keeps the docs ↔ in-repo tutorials bridge instead of collapsing onboarding to quickstart-only

Test plan

  • Verify Quick Start links resolve: get-started, main docs, Core Concepts, quickstart.py
  • Confirm onboarding copy matches each destination's purpose

Made with Cursor

lbliii and others added 2 commits June 22, 2026 11:32
…heading

Removed link to the Getting Started Guide in favor of quickstart example.

Co-authored-by: Cursor <cursoragent@cursor.com>
Builds on the prior commit by replacing the quickstart-only CTA with a
clear sequence: install via docs, read Core Concepts, then run
quickstart.py.

Co-authored-by: Cursor <cursoragent@cursor.com>
@lbliii lbliii requested a review from a team as a code owner June 22, 2026 15:32
@lbliii lbliii requested review from meatybobby and removed request for a team June 22, 2026 15:32
@copy-pr-bot

copy-pr-bot Bot commented Jun 22, 2026

Copy link
Copy Markdown

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.

@greptile-apps

greptile-apps Bot commented Jun 22, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR refines the Quick Start section of the tutorials README, replacing a single catch-all sentence with a structured 3-step onboarding sequence that separates installation, conceptual reading, and hands-on practice.

  • Removes the previous "Getting Started Guide" link that conflated install steps with core concepts, replacing it with three clearly-scoped steps.
  • Adds explicit links to the main docs root, the Core Concepts page, and the existing quickstart.py file in a logical progression.

Confidence Score: 5/5

Documentation-only change with no code impact; safe to merge.

The change touches a single Markdown file, restructuring a short paragraph into a numbered list and updating one external URL. There is a minor URL format inconsistency between the new Quick Start step and the Documentation Links table in the same file, but both forms resolve to the same page.

No files require special attention.

Important Files Changed

Filename Overview
tutorials/README.md Quick Start section rewritten from a single-sentence blurb to a 3-step numbered onboarding sequence with distinct links for install, core concepts, and the hands-on quickstart script.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["New to NeMo Curator?"] --> B["Step 1: Install & run a modality quickstart\n(docs.nvidia.com/nemo/curator/latest/get-started/)"]
    B --> C["Step 2: Read Core Concepts\n(docs.nvidia.com/nemo/curator/latest/about/concepts)"]
    C --> D["Step 3: Run quickstart.py\n(Tasks, Stages, Pipelines)"]
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["Step 1: Install & run a modality quickstart\n(docs.nvidia.com/nemo/curator/latest/get-started/)"]
    B --> C["Step 2: Read Core Concepts\n(docs.nvidia.com/nemo/curator/latest/about/concepts)"]
    C --> D["Step 3: Run quickstart.py\n(Tasks, Stages, Pipelines)"]
Loading

Reviews (1): Last reviewed commit: "docs: expand Quick Start with docs and C..." | Re-trigger Greptile

Comment thread tutorials/README.md
**New to NeMo Curator?**

1. [Install and run a modality quickstart](https://docs.nvidia.com/nemo/curator/latest/get-started/) from the [documentation](https://docs.nvidia.com/nemo/curator/latest/)
2. Read [Core Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts) to learn the pipeline architecture

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The Core Concepts URL here uses the path without index.html, while the Documentation Links table lower in the same file uses /about/concepts/index.html. Both likely resolve correctly via redirect, but aligning the format avoids a subtle inconsistency for anyone copying links from the README.

Suggested change
2. Read [Core Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts) to learn the pipeline architecture
2. Read [Core Concepts](https://docs.nvidia.com/nemo/curator/latest/about/concepts/index.html) to learn the pipeline architecture

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

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.

1 participant