Fix installation guide link in build_maxtext.md - #4828
Conversation
There was a problem hiding this comment.
Code Review
This pull request updates a relative link in the installation guide documentation to an absolute ReadTheDocs URL. The reviewer pointed out that hardcoding a specific version (maxtext-v0.2.3) in the URL makes it brittle and suggested using 'latest' or 'stable' instead to ensure the link remains up to date.
| ## 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. |
There was a problem hiding this comment.
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
Description
Start with a short description of what the PR does and how this is a change from
the past.
The rest of the description includes relevant details and context, examples:
If the change fixes a bug or a Github issue, please include a link, e.g.,:
FIXES: b/123456
FIXES: #123456
You can also provide a comma-separated list. If you don't want to close a bug but
simply to reference it, use BUGS, e.g.:
BUGS: b/123456
Notice 1: Once all tests pass, the "pull ready" label will automatically be assigned.
This label is used for administrative purposes. Please do not add it manually.
Notice 2: For external contributions, our settings currently require an approval from a MaxText maintainer to trigger CI tests.
Tests
Please describe how you tested this change, and include any instructions and/or
commands to reproduce.
Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.