Make all links internal (where possible)#3671
Open
melissawm wants to merge 1 commit intoAI-Hypercomputer:mainfrom
Open
Make all links internal (where possible)#3671melissawm wants to merge 1 commit intoAI-Hypercomputer:mainfrom
melissawm wants to merge 1 commit intoAI-Hypercomputer:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes the issue where links were hardcoded to the latest version of the documentation. This includes creating anchors (such as
(checkpoint-conversion)=) and using this anchor when creating a link to that page. In other cases, linking out to the explicit markdown file is appropriate, and a link will be correctly created when the documentation is built for the ReadTheDocs website.For consistency, all links to internal documentation should be done using internal link syntax; this will guarantee that each build of the documentation is consistent with respect to versioning. One exception is the "Update dependencies" page, where we explicitly want to link out to the latest version of the "Install MaxText" page.
Tests
Docs build correctly locally and links are created as expected.
Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.