Skip to content

Updates installation page organization and contents#3542

Merged
copybara-service[bot] merged 1 commit intoAI-Hypercomputer:mainfrom
melissawm:install-maxtext
Apr 13, 2026
Merged

Updates installation page organization and contents#3542
copybara-service[bot] merged 1 commit intoAI-Hypercomputer:mainfrom
melissawm:install-maxtext

Conversation

@melissawm
Copy link
Copy Markdown
Collaborator

Description

Updates installation page contents and structure, with focus on complying with the Google Technical Writing Guidelines and team feedback.

Also splits the "How to update requirements" to a separate page under a "development" folder, containing documentation on how to contribute.

Tests

Documentation builds locally.

Checklist

Before submitting this PR, please make sure (put X in square brackets):

  • I have performed a self-review of my code. For an optional AI review, add the gemini-review label.
  • [N/A] I have necessary comments in my code, particularly in hard-to-understand areas.
  • [N/A] I have run end-to-end tests tests and provided workload links above if applicable.
  • I have made or will make corresponding changes to the doc if needed, including adding new documentation pages to the relevant Table of Contents (toctree directive) as explained in our documentation.

Comment thread docs/install_maxtext.md
Comment thread docs/install_maxtext.md Outdated
@melissawm
Copy link
Copy Markdown
Collaborator Author

The docs build here will pass once #3247 is merged.

Comment thread docs/development/update_dependencies.md Outdated
Comment thread docs/development/update_dependencies.md Outdated
Comment thread docs/development/update_dependencies.md Outdated
Comment thread docs/development/update_dependencies.md Outdated
Comment thread docs/development/update_dependencies.md Outdated
Comment thread docs/development/update_dependencies.md Outdated
Comment thread docs/install_maxtext.md Outdated
Comment thread docs/install_maxtext.md
Comment thread docs/install_maxtext.md
@melissawm
Copy link
Copy Markdown
Collaborator Author

Just updated this PR with the following changes:

  • Reorganized the "Update dependencies" guide so that the summary steps match the detailed steps. Please let me know if the steps are correct;
  • Added a target to the "From source" section of the "Install MaxText" page so we can link to it directly internally;
  • Rebased the contents of the PR to match the main branch.

Let me know if you have further feedback. Thanks!

Comment thread docs/development/update_dependencies.md
Comment thread docs/development/contribute_docs.md Outdated
Comment thread docs/development/contribute_docs.md Outdated
Comment thread docs/install_maxtext.md Outdated
Comment thread docs/install_maxtext.md Outdated
Comment thread docs/install_maxtext.md Outdated
Comment thread docs/install_maxtext.md Outdated
* Add instructions to clone repo

* Improve contributing docs

* Review updating dependencies instructions

* Address review comments
@melissawm
Copy link
Copy Markdown
Collaborator Author

I have rebased and squashed this PR to resolve some conflicts. Let me know if you have further comments.

cc @jacoguzo

@copybara-service copybara-service Bot merged commit 35e07f9 into AI-Hypercomputer:main Apr 13, 2026
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants