Docs: Enhance landing pages for Run, Guides, and Reference#2839
Closed
RobMulla wants to merge 1 commit intoAI-Hypercomputer:mainfrom
Closed
Docs: Enhance landing pages for Run, Guides, and Reference#2839RobMulla wants to merge 1 commit intoAI-Hypercomputer:mainfrom
RobMulla wants to merge 1 commit intoAI-Hypercomputer:mainfrom
Conversation
jacoguzo
requested changes
Dec 16, 2025
Collaborator
jacoguzo
left a comment
There was a problem hiding this comment.
These look good but I think there will be many conflicts with this PR. Maybe these descriptions could be ported into the descriptions of the cards. https://github.com/AI-Hypercomputer/maxtext/pull/2821/files
|
This PR has been automatically marked as stale because it has not had recent activity. It will be closed soon if no further activity occurs. Thank you for your contributions. |
|
This PR was closed because it has been inactive for a while. Please reopen it if you are still working on it. |
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
Improving the documentation landing pages to provide context and helpful summaries instead of bare lists of links.
Changes
docs/run_maxtext.md): Categorized execution methods into "Local & Single Host" (e.g., Localhost, Single NVIDIA GPU) and "Multi-Host & Cluster" (XPK, Pathways). Added descriptions for each method.docs/guides.md): Grouped guides into "Performance & Optimization", "Data & Storage", and "Development Workflows" with brief summaries.docs/reference.md): Organized into "Core Concepts" and "Benchmarks & Models" to help users find technical details faster.Motivation
New users landing on these pages previously saw only a list of file links without context. These changes help users navigate to the right document based on their specific goal (e.g., "I want to run locally" vs "I want to optimize performance").
Verification
sphinx-build) to verify rendering and links.Checklist
Before submitting this PR, please make sure (put X in square brackets):
gemini-reviewlabel.