Skip to content

Docs streamline fixes#2838

Closed
RobMulla wants to merge 5 commits intoAI-Hypercomputer:mainfrom
RobMulla:docs-streamline-fixes
Closed

Docs streamline fixes#2838
RobMulla wants to merge 5 commits intoAI-Hypercomputer:mainfrom
RobMulla:docs-streamline-fixes

Conversation

@RobMulla
Copy link
Copy Markdown
Contributor

@RobMulla RobMulla commented Dec 16, 2025

Description

Title

Docs: Streamline "First Run" tutorial and "Tutorials" landing page

Description

Improves the "Day 0" experience by making the tutorials landing page more useful and the "First Run" tutorial copy-paste friendly.

Changes

  • Landing Page (tutorials.md): Added a "New to MaxText?" section and descriptions for tutorial categories.
  • First Run Tutorial (first_run.md):
    • Added export BUCKET_NAME to simplify copy-pasting.
    • Replaced links with explicit gcloud commands for bucket creation.
    • Added inline configs/base.yml snippet to show default model params (1B, float32).
    • Clarified execution paths (cd MaxText) and checkpoint usage for decoding.

Motivation

Smooths out friction points for new users - preventing common errors like FileNotFoundError (missing cd) or correct bucket permissions.

Verification

  • Built and verified docs locally (sphinx-build).

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.
  • I have necessary comments in my code, particularly in hard-to-understand areas.
  • 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.

cd ~/MaxText
```

4. Within the root directory of the cloned repo, install dependencies and pre-commit hook by running:
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.

These are the outdated instructions to install MaxText. Can you update this and refer to https://maxtext.readthedocs.io/en/latest/install_maxtext.html#from-source?

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Feb 5, 2026

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.

@github-actions github-actions Bot added the stale Automatically applied to stale PRs. label Feb 5, 2026
@github-actions
Copy link
Copy Markdown

This PR was closed because it has been inactive for a while. Please reopen it if you are still working on it.

@github-actions github-actions Bot closed this Feb 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

stale Automatically applied to stale PRs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants