Skip to content

Fix installation guide link in build_maxtext.md #4828

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
lydhr wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Fix installation guide link in build_maxtext.md #4828

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/tutorials/build_maxtext.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ If the `docker run hello-world` command fails with a permission denied error (e.

## Installation Modes

Follow the instructions in the [Installation guide](../install_maxtext.md) to install the `maxtext[runner]` extra, which includes all necessary dependencies for building MaxText Docker images and running workloads through XPK. It automatically installs XPK, so you do not need to install it separately to manage your clusters and workloads.
Follow the instructions in the [Installation guide](https://maxtext.readthedocs.io/en/maxtext-v0.2.3/install_maxtext.html) to install the `maxtext[runner]` extra, which includes all necessary dependencies for building MaxText Docker images and running workloads through XPK. It automatically installs XPK, so you do not need to install it separately to manage your clusters and workloads.

@gemini-code-assist gemini-code-assist Bot Aug 11, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

medium

Hardcoding a specific version (maxtext-v0.2.3) in the documentation URL makes it brittle and prone to becoming outdated when new versions are released. Consider using latest or stable in the ReadTheDocs URL to ensure the link always points to the most current version of the installation guide.

For example:
https://maxtext.readthedocs.io/en/latest/install_maxtext.html

@SurbhiJainUSC SurbhiJainUSC Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Don't hardcode the link. We should use relative links.


## Pre-built MaxText Docker images

Expand Down
Loading