Skip to content

Update geting started doc#4094

Merged
copybara-service[bot] merged 1 commit into
mainfrom
getting_started_doc
Jun 9, 2026
Merged

Update geting started doc#4094
copybara-service[bot] merged 1 commit into
mainfrom
getting_started_doc

Conversation

@SurbhiJainUSC

@SurbhiJainUSC SurbhiJainUSC commented Jun 6, 2026

Copy link
Copy Markdown
Collaborator

Description

This PR transitions the "First Run" tutorial (first_run.md) into a top-level "Getting Started" guide (getting_started.md).

Instead of hosting inline installation and run commands (which quickly become outdated or duplicated), the document now serves as a landing page. It guides users through prerequisites and then points them to the dedicated, detailed guides for installation, pre-training, post-training, inference, and notebook usage.

Tests

Locally build:
https://screenshot.googleplex.com/4RMpSB5gm3tJNcB
https://screenshot.googleplex.com/7zxFKPHfCDcFJxs

Checklist

Before submitting this PR, please make sure (put X in square brackets):

  • I have performed a self-review of my code. For an optional AI review, add the gemini-review label.
  • I have necessary comments in my code, particularly in hard-to-understand areas.
  • I have run end-to-end tests tests and provided workload links above if applicable.
  • I have made or will make corresponding changes to the doc if needed, including adding new documentation pages to the relevant Table of Contents (toctree directive) as explained in our documentation.

@SurbhiJainUSC SurbhiJainUSC force-pushed the getting_started_doc branch 2 times, most recently from 58676be to 4084e51 Compare June 8, 2026 16:25
@SurbhiJainUSC SurbhiJainUSC requested a review from parambole as a code owner June 8, 2026 16:25
@codecov

codecov Bot commented Jun 8, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@SurbhiJainUSC SurbhiJainUSC force-pushed the getting_started_doc branch from 4084e51 to bf8ab4f Compare June 8, 2026 17:21
@copybara-service copybara-service Bot merged commit 2e32283 into main Jun 9, 2026
33 checks passed
@copybara-service copybara-service Bot deleted the getting_started_doc branch June 9, 2026 00:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants