Skip to content

Conversation

@jacoguzo
Copy link
Collaborator

Description

FIXES: b/463397633

Issue: Customers may prefer for a command they can edit rather than writing in one by one as it is currently set up in Step 4 in the maxtext read the docs. The documentation should provide a template command they can edit/copy-paste rather than forcing them to construct it one by one.

This PR changes all env variable blocks in the tutorials to have editable text.

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):

  • 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.

Copy link
Collaborator

@melissawm melissawm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good, I'm not a javascript expert but the built docs look and work correctly. Nice @jacoguzo !

@SurbhiJainUSC
Copy link
Collaborator

This looks good, I'm not a javascript expert but the built docs look and work correctly. Nice @jacoguzo !

Where can I see an example of the doc build with this change?

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.

4 participants