Skip to content

Conversation

@faradawn
Copy link

@faradawn faradawn commented Feb 2, 2026

Description

Fixed broken links to non-existent quickstart.ipynb file in documentation.

Fixes #2640

Type of change

  • Documentation change (change only to the documentation, either a fix or a new content)
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Infra/Build change
  • Code refactoring

Changes

  • Updated README.rst (line 140) to point to existing tutorials:
    • JAX Integration Tutorial (te_jax_integration.ipynb)
    • Getting Started Guide (docs/getting_started/index.rst)
  • Updated examples/README.md (line 26) to point to JAX Integration Tutorial

Checklist:

  • I have read and followed the contributing guidelines
  • The functionality is complete
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Signed-off-by: Faradawn Yang <73060648+faradawn@users.noreply.github.com>
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 2, 2026

Greptile Overview

Greptile Summary

This PR fixes broken documentation links that pointed to a non-existent quickstart.ipynb file. The links have been updated to reference existing resources: the JAX Integration Tutorial (te_jax_integration.ipynb) and the Getting Started Guide (docs/getting_started/index.rst).

Changes:

  • README.rst: Replaced broken quickstart link with two valid alternatives
  • examples/README.md: Updated quickstart reference to JAX Integration Tutorial with accurate description

All target files have been verified to exist in the repository. This is a straightforward documentation fix with no code changes.

Confidence Score: 5/5

  • This PR is completely safe to merge with zero risk
  • This is a pure documentation change that only updates broken links to point to existing files. All target files have been verified to exist, and no code logic is affected.
  • No files require special attention

Important Files Changed

Filename Overview
README.rst Fixed broken link from non-existent quickstart.ipynb to valid JAX Integration Tutorial and Getting Started Guide
examples/README.md Updated broken quickstart link to JAX Integration Tutorial with accurate description

Sequence Diagram

sequenceDiagram
    participant User
    participant README.rst
    participant examples/README.md
    participant Old Link
    participant New Links
    
    User->>README.rst: Click quickstart link
    README.rst->>Old Link: quickstart.ipynb
    Old Link-->>User: 404 - File not found
    
    Note over README.rst,examples/README.md: PR fixes broken links
    
    User->>README.rst: Click updated link
    README.rst->>New Links: te_jax_integration.ipynb or getting_started/index.rst
    New Links-->>User: Valid documentation loaded
    
    User->>examples/README.md: Click TE tutorial link
    examples/README.md->>New Links: te_jax_integration.ipynb
    New Links-->>User: Valid tutorial loaded
Loading

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

2 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@ptrendx ptrendx requested a review from pggPL February 2, 2026 17:51
loss, (param_grads, other_grads) = fwd_bwd_fn(params, other_variables, inp)

For a more comprehensive tutorial, check out our `Quickstart Notebook <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/quickstart.ipynb>`_.
For a more comprehensive tutorial, check out our `JAX Integration Tutorial <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/te_jax_integration.ipynb>`_ or the `Getting Started Guide <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/getting_started/index.rst>`_.
Copy link
Member

Choose a reason for hiding this comment

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

Hi, could you switch the order of those to have the Getting Started page as the first one?

Copy link
Member

Choose a reason for hiding this comment

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

Actually, maybe we should instead just point to the Getting Started HTML page here: https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/getting_started.html

@ptrendx
Copy link
Member

ptrendx commented Feb 2, 2026

Thanks for the contribution - I left one small comment and then we can merge.

loss, (param_grads, other_grads) = fwd_bwd_fn(params, other_variables, inp)

For a more comprehensive tutorial, check out our `Quickstart Notebook <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/quickstart.ipynb>`_.
For a more comprehensive tutorial, check out our `JAX Integration Tutorial <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/te_jax_integration.ipynb>`_ or the `Getting Started Guide <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/getting_started/index.rst>`_.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
For a more comprehensive tutorial, check out our `JAX Integration Tutorial <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/te_jax_integration.ipynb>`_ or the `Getting Started Guide <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/getting_started/index.rst>`_.
For a more comprehensive tutorial, check out our `JAX Integration Tutorial <https://github.com/NVIDIA/TransformerEngine/blob/main/docs/examples/te_jax_integration.ipynb>`_ or the `Getting Started Guide <https://docs.nvidia.com/deeplearning/transformer-engine/user-guide/getting_started.html>`_.

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.

Broken link of quickstart guide on frontpage README

3 participants