Skip to content

Add documentation skill for manual review - #3822

Closed
melissawm wants to merge 1 commit into
AI-Hypercomputer:mainfrom
melissawm:add-documentation-skill
Closed

melissawm wants to merge 1 commit into
AI-Hypercomputer:mainfrom
melissawm:add-documentation-skill

Conversation

@melissawm

Copy link
Copy Markdown
Collaborator

Description

This PR, previously discussed with the team, adds a Gemini skill to review documentation pages according to the Google Technical Writing style guide and specific MaxText guidance previously written.

The skill will not run automatically. Those interested in using it can activate their Gemini CLI from the MaxText repo and run something like:

/documentation-style review docs/install_maxtext.md

The skill will suggest changes that help with consistency, formatting and other general guidance, including docstrings. For example:

/documentation-style review docstring in src/maxtext/checkpoint_conversion/to_huggingface.py:main

Tests

Tested locally for both narrative documentation and docstrings.

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

@bvandermoon bvandermoon left a comment

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.

Does this only work with Gemini CLI? Or does it also work with Antigravity/internal equivalents?

@melissawm

Copy link
Copy Markdown
Collaborator Author

I am pretty sure skills are general enough to be used by any tool, but unfortunately I don't have access to those tools so I'm not able to test it.

@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

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 Jun 5, 2026
@github-actions

Copy link
Copy Markdown
Contributor

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 Jun 12, 2026
@shralex shralex reopened this Jun 15, 2026
@shralex
shralex requested a review from darisoy as a code owner June 15, 2026 19:51
@github-actions github-actions Bot removed the stale Automatically applied to stale PRs. label Jun 17, 2026
@melissawm
melissawm force-pushed the add-documentation-skill branch from f8530e8 to 2f7b3ce Compare June 18, 2026 12:40
@melissawm

Copy link
Copy Markdown
Collaborator Author

Hi folks, anything I can do to move this forward? Thanks!

@github-actions

Copy link
Copy Markdown
Contributor

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 Aug 25, 2026
@github-actions

Copy link
Copy Markdown
Contributor

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 Sep 18, 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.

5 participants