AGENT.md

uv package manager by default

This project uses the uv package manager.

• To add a dependency, run uv add <package>.
• To run a script, run uv run <script>.
• To examine dependencies, consult the pyproject.toml file.

Testing

• Always run tests before committing. The test command is ./scripts/run_checks.sh.

Releases

• If asked to help with a release, refer to the checklist in CONTRIBUTING.md. Be sure to first share a draft of the release notes with the user before actually publishing the release to GitHub.

Documentation

• All documentation is in the docs directory.
• If you add a new page, be sure to add it to the sidebar in docs/docs.json.
• If you move a page, be sure to update the sidebar in docs/docs.json and check for any broken links.

Adding images

• Add images to the docs/images directory
• If the image is a png, first convert it to webp using magick <input.png> <output.webp>. Do not include the original png in the repo.
• Use the <Frame> tag to add images with captions as seen in the page checkpoint-forking.mdx.

Adding notes

• Add notes using the <Note> tag as seen in the page ruler.mdx